Delete Mailing List
Using this API, you can delete a mailing list. All you need to provide is the list key and choose whether to delete all list leads or retain them in the organization.
Scope required
- ZohoMarketingAutomation.lead.DELETE
Other alternative scopes
- ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
- ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Content-Type: application/x-www-form-urlencoded
Request type:
- GET/POST
Request URL
https://marketingautomation.zoho.com/api/v1/deletemailinglist
API Limit
- Duration: 5 mins
- Number of Calls: 500
- Lock Period: 30 mins
You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.
List of parameters
Parameter | Data type | Description |
listkey* | String | List Key to send a subscription mail to leads. |
resfmt | String | JSON |
deleteleads | String | on/off |
* - Mandatory parameters
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/deletemailinglist?resfmt=JSON&listkey=listkey&deleteleads=[on/off]
Sample Response
Copied{
"message": "List(s) are deleted successfully!",
"status": "success",
"code": "0",
"uri": "/api/v1/deletemailinglist",
"version": "1"
}