The section describes the JSON request to get list details
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/getList?list_id=2 |
Field Details
|
Label/Variable |
Priority |
Description |
| list_id |
Required |
List ID is required in order to retrieve particular list |
Success Response
You will get the following response upon submitting appropriate request and correct ID of the particular list
Status value for successfully getting list will be- “success”
Data Returned- List ID, List Name, List Owner Name, List Owner Email, List Bounce Email, List Reply to Email, Number of Subscribers, Date of Creation
{"status":"success","response":[{"list_id":"2","list_name":"Example List","list_owner_name":"Testing Owner","list_owner_email":"[email protected]","list_bounce_email":"","list_reply_email":"[email protected]","contacts":"12","create_date":"2019-11-30"}]}
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.