Delete Unsubscribe Link

Purpose

To delete an unsubscribe link.

Endpoints

Request Details

Request URL

{api-domain}/crm/{version}/settings/unsubscribe_links/{unsubscribe_link_id}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

scope = ZohoCRM.settings.unsubscribe.ALL
(or)
scope = ZohoCRM.settings.unsubscribe.DELETE

Note

You cannot delete the Default unsubscribe link.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v6/settings/unsubscribe_links/2309216000000582097"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Possible Errors

  • INVALID_URL_PATTERNHTTP 404

    Please check if the URL trying to access is a correct one
    Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.

  • OAUTH_SCOPE_MISMATCHHTTP 401

    Unauthorized
    Resolution: Client does not have the required OAUTH SCOPE. Create a new client with valid scope. Refer to scope section above for more details.

  • INTERNAL_ERRORHTTP 500

    Internal Server Error
    Resolution: Unexpected and unhandled exception in Server. Contact support team.

  • INVALID_REQUEST_METHODHTTP 400

    The http request method type is not a valid one
    Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.

  • INVALID_DATAHTTP 400

    The given Unsubscribe Link id is not part of Org
    Resolution: Specify a valid unsubscribe link ID.

  • NOT_ALLOWEDHTTP 400

    The given Unsubscribe Link id is Default 
    Resolution: You canont delete the Default unsubscribe link.

Sample Response

Copied{
    "unsubscribe_links": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "2309216000000582097"
            },
            "message": "Unsubscribe Link deleted successfully",
            "status": "success"
        }
    ]
}