The section describes the JSON request to update a 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/updateList |
Field Details
|
Label/Variable |
Priority |
Description |
|
list_id |
Required |
ID of the particular list you want to update |
|
list_name |
Required |
Name of the list another requirement to submit the request successfully |
|
list_owner_name |
Required |
Update the name of the person who owns the list |
|
list_reply_to_email |
Required |
Update reply to email for the list |
|
list_bounce_email |
Required |
Update bounced email information |
|
list_owner_email |
Required |
Email of the person who owns the list, update accordingly |
Success Response
Upon submitting valid request
Status value for successfully updating list will be- “success”
Data Returned- List ID
{"status":"success","response":{"List ID":"3"}}
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
If the list ID is incorrect or not mentioned
{"status":"error","response":"List not available to update"}
When the list name isn’t mentioned
{"status":"error","response":"List Name is required to update list"}