The section describes the JSON request to add a new list
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 |
POST |
|
Path |
https://portal.smtp-plans.com/API/addList |
Field Details
|
Label/ Variable |
Priority |
Description |
|
list_name |
Required |
Name of the subscriber list you are going to add. |
|
list_owner_name |
Required |
Name of the person who owns the list |
| list_reply_email |
Required |
The email address where you want to receive and collect the replies from the recipients. |
|
list_bounce_email |
Required |
Bounce email address where you want to receive and collect the bounced/ non-delivery report for this list. |
|
list_owner_email |
Required |
Email address associated with the owner of the list, it is also used as “From Email” of the list owner. |
Success Response
You’ll get the following JSON response upon submitting valid information to add subscriber list.
Status value for successfully added list will be- “success”
Data Returned-"List ID"
{"status":"success","response":{"List ID":"8"}}
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
{"status":"error","response":"Owner Email is required to create list"}
{"status":"error","response":"List Name is required to create list"}