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
| Parameter | Data Type | Description |
| listkey* | String | List Key is used to unsubscribe contacts from the list. |
| resfmt | String | XML (or) JSON |
| contactinfo* | XML (or) JSON | Contact email with other fields. Format of this value depends on the request URL. |
| topic_id | String | Topic ID for the topic created |
* - Mandatory Parameters
Possible error cases
| Error code | Description |
| 2101 | Please retry after sometime. |
If your error code is not listed above, click here.
Sample XML Request
Copied
Sample Response
Copied
Sample JSON Request
Copied
Sample Response
Copied