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

    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_idStringTopic ID for the topic created

    * - Mandatory Parameters

    Possible error cases

    Error code Description
    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"
}