Get Unsubscribe Links
Purpose
To fetch the details of unsubscribe links set up in your CRM account.
Request Details
Request URL
{api-domain}/crm/{version}/settings/unsubscribe_links
To fetch a specific unsubscribe link:
{api-domain}/crm/{version}/settings/unsubscribe_links/{link_id}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope= ZohoCRM.settings.unsubscribe_links.READ
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v6/settings/unsubscribe_links"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Response JSON Keys
- namestring
The name of the unsubscribe link.
- idstring
The unique id of the unsubscribe link.
- created_timedatetime
The date and time at which the unsubscribe link was created.
- created_byJSON object
Details of the user who created the unsubscribe link.
- modified_timedatetime
The date and time at which the unsubscribe link was last modified.
- modified_byJSON object
Details of the user who last modified the unsubscribe link details.
- page_typestring
Represents whether the unsubscribe is hosted in a standard page designed by Zoho CRM, or a custom webpage. The possible values are standard and custom.
- custom_location_urlstring
Represents the custom webpage, where the unsubscribe link is hosted. The value will be null if the link is hosted in the standard Zoho desgined webpage.
- standard_page_messagestring
The message that will be displayed on the standard unsubscribe page, along with the unsubscribe link.
- submission_action_type string
Represents the action to be performed when the user clicks the unsubscribe button. Depending on how the link is configured, the value could either be display_message or redirect.
- submission_redirect_urlstring
Represents the web page's URL to which the user will be redirected after clicking on the unsubscribe link.
- submission_messagestring
The message that will be displayed once the user clicks the unsubscribe button.
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.
Sample Response
Copied{
"unsubscribe_links": [
{
"created_time": "2023-12-12T13:08:43+05:30",
"submission_message": "display message",
"modified_time": "2023-12-12T13:08:43+05:30",
"submission_redirect_url": null,
"page_type": "custom",
"custom_location_url": "https://custompage.com/unsubscribe",
"modified_by": {
"name": "Patricia Boyle",
"id": "2309216000000476001"
},
"name": "Default",
"id": "2309216000000582076",
"created_by": {
"name": "Patricia Boyle",
"id": "2309216000000476001"
},
"standard_page_message": null,
"submission_action_type": "display_message"
}
}