The section describes the JSON request to delete a subscriber from 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/deleteSubscriber |
Field Details
|
Label/ Variable |
Priority |
Description |
|
subscriber_id |
Required |
Subscriber ID is required to delete particular subscriber using API request |
Success Response
Upon providing appropriate information along with correct Subscriber ID, required subscriber will be deleted and you will get success response as below.
Status value for the successfully deleted subscriber will be- “success” Data Returned-"Subscriber ID"
{"status":"success","response":{"Subscriber ID":"2"}}
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
Some erroneous responses are as follows.
{"status":"error","response":"Subscriber not available to delete"}