Manage And Connect Using APIs

Contact Unsubscribe

Disinterested subscribers in your list? Never mind, all you need to do is enter the API Authentication Token to unsubscribe and the user will be notified.

Request URL:

XML: https://campaigns.zoho.com/api/xml/listunsubscribe

JSON: https://campaigns.zoho.com/api/json/listunsubscribe

Request Type: Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Tokent
CampaignsAPI

listkey*

String

List Key use to Unsubscribe Contacts

version

String

This will fetch responses based on the current API version

resfmt

String

XML (or) JSON

contactinfo*

XML (or) JSON

Contact email with other fields. Format of this value depends on the request URL.

* - Mandatory Parameters

Sample Request:

XML:

https://campaigns.zoho.com/api/xml/listunsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[XML/JSON]&listkey=[listkey]&contactinfo=<xml><fl val="First Name">mac</fl><fl val="Contact Email">jai@zoho.com</fl></xml>

JSON:

https://campaigns.zoho.com/api/json/listunsubscribe?authtoken=[API Authentication Token]&scope=CampaignsAPI&version=1&resfmt=[XML/JSON]&listkey=[listkey]&contactinfo={First Name:mac,Last Name:Last Name,Contact Email:jai@zoho.com}

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format:

XML Format

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

JSON format

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

Top