The section describes the JSON request to delete 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/deleteList |
Field Details
|
Label |
Priority |
Description |
|
list_id |
Required |
The only required field to delete particular list is its ID. |
Success Response
Upon providing appropriate information such as API token, username, path and valid list ID, you will get your list deleted and will be given the following response.
Status value for successfully deleted 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
An example of error response is when you initiate the request without the list ID.
{"status":"error","response":"List ID is required to delete the list"}