The section describes the JSON request to get a subscriber detail
Required to Submit JSON Request
|
Username |
The email that account holder uses to login SMTP PLANS |
|
API Token |
The API token user has generated using API Configuration section |
|
Method |
GET |
|
Path |
https://portal.smtp-plans.com/API/getSubscriber?subscriber_id=4 |
Field Details
|
Label/ Variable |
Priority |
Description |
|
subscriber_id |
Required |
Subscriber ID is required to get subscriber details |
Success Response
In case of submitting valid request, it returns the following data in JSON format.
Status value for successfully getting subscriber will be- “success”
Data Returned- Subscriber ID, List ID, Email, title, first name, last name, unsubscribed, bounced, format, verification status, confirmation status, city, post code, country, mobile, phone, fax
{"status":"success","response":[{"subscriber_id":"4", "list_id":"2", "email":"[email protected]", "title":"", "first_name":"", "last_name":"", "unsubscribed":"0", "unsubscribed_date":"0000-00-00 00:00:00", "bounced":"0", "bounced_date":"0000-00-00 00:00:00", "create_date":"2019-01-30 19:54:41", "format":"h", "confirmation_status":"1", "verification_status":"0", "city":"", "state":"", "post_code":"", "country":"", "mobile":"", "phone":"", "fax":"0"}]}
Erroneous Response
When you submit request with inappropriate, incorrect information.
Status value for unsuccessful submission will be- “error”
Data Returned- Text based message describing reason of unsuccessful response
Following is the example of unsuccessful response
{"status":"error","response":"Subscriber ID is required to get subscriber"}