Unsubscribe

Disinterested leads in your list? Never mind, all you need to do is unsubscribe them. Using this API, you can unsubscribe leads and they will be notified.

Scope required

  • ZohoMarketingAutomation.lead.UPDATE

    Other alternative scopes

    • ZohoMarketingAutomation.lead.CREATE-UPDATE (CREATE + UPDATE)
    • ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
    • ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)

    Header:

    Header-Authorization: Zoho-oauthtoken <access_token>

    Content-Type: application/x-www-form-urlencoded

    Request Type:

    • Post

    Request URL

    https://marketingautomation.zoho.com/api/v1/json/listunsubscribe

    List of parameters

    Parameter

    Data type

    Description

    listkey*

    String

    List Key of the list from which the leads should be removed.

    resfmt

    String

    JSON

    leadinfo*

    JSON

    Lead email with other fields.

    topic_idStringTopic ID to unsubscribe topics from leads in the mailing list. You can pass comma separated topic IDs as well. 

    * - Mandatory parameters

     

    Possible error cases

    Error code

    Description

    2101

    Please retry after sometime.

    If your error code is not listed above, clickhere.

    Sample request

    Copiedhttps://marketingautomation.zoho.com/api/v1/json/listunsubscribe?resfmt=JSON&listkey=[listkey  ]&leadinfo=%7BFirst+Name%3Apatricia%2CLast+Name%3ALast+Name%2CLead+Email%3Apatricia%40zoho.com%7D

    Sample Response

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