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 contacts from the organization or remove them only from the list.
Request Type
- Get
Scope required
ZohoCampaigns.contact.DELETE
Other alternative scopes
- ZohoCampaigns.contact.WRITE (CREATE + UPDATE + DELETE)
- ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Content-Type: application/x-www-form-urlencoded
Request URL
https://campaigns.zoho.com/api/v1.1/deletemailinglist
List of Parameters -- Version 1.1
Parameter | Data Type | Description |
listkey* | String | List Key to send a subscription mail to contacts. |
resfmt | String | XML (or) JSON |
deletecontacts | String | on/off |
* - Mandatory Parameters
Sample XML Request
Copiedhttps://campaigns.zoho.com/api/v1.1/deletemailinglist?resfmt=XML&listkey=listkey&deletecontacts=[on/off]
Sample Response
Copied<response uri="/api/v1.1/deletemailinglist" version="1.1">
<code>0</code>
<status>success</status>
<message>List(s) are deleted successfully!</message>
</response>
Sample JSON Request
Copiedhttps://campaigns.zoho.com/api/v1.1/deletemailinglist?resfmt=JSON&listkey=listkey&deletecontacts=[on/off]
Sample Response
Copied{
"message": "List(s) are deleted successfully!",
"status": "success",
"code": "0",
"uri": "/api/v1.1/deletemailinglist",
"version": "1.1"
}