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

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 -- Version 1.1

ParameterData TypeDescription
listkey*StringList Key to send a subscription mail to contacts.
resfmtStringXML (or) JSON
deletecontactsStringon/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"
}