Unsubscribe

Disinterested leads in your list? Never mind, all you need to do is unsubscribe them. Using this API, you can unsubscribe leads from your end.

Request Type

  • POST

Scope required

  • ZohoCampaigns.contact.UPDATE

Other alternative scopes

  • ZohoCampaigns.contact.CREATE-UPDATE (CREATE + UPDATE)
  • 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/[xml/json]/listunsubscribe

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 is used to unsubscribe contacts from the list.
resfmtStringXML (or) JSON
contactinfo*XML (or) JSONContact email with other fields. Format of this value depends on the request URL.
topic_idStringTopic ID for the topic created

* - Mandatory Parameters

Possible error cases

Error codeDescription
2101Please retry after sometime.

If your error code is not listed above, click here.

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/xml/listunsubscribe?resfmt=XML&listkey=[listkey  ]&contactinfo=<xml><fl val="First Name">mac</fl><fl val="Contact Email">jai@zoho.com</fl></xml>

Sample Response

Copied<response uri="/api/xml/listunsubscribe" version="1.1">
<code>0</code>
<status>success</status>
<message>User successfully unsubscribed.</message>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1/json/listunsubscribe?resfmt=JSON&listkey=[listkey  ]&contactinfo=%7BFirst+Name%3Amac%2CLast+Name%3ALast+Name%2CContact+Email%3Ajai%40zoho.com%7D

Sample Response

Copied{
  "message": "User successfully unsubscribed.",
  "status": "success",
  "code": "0",
  "uri": "/api/v1.1/json/listunsubscribe",
  "version": "1.1"
}