Zoho crm Logo

获取退订链接

目的

要获取在您的CRM账户中设置的退订链接的详细信息。

端点

  • GET /settings/unsubscribe_links
  • GET /settings/unsubscribe_links/{link_ID}

请求详情

请求 URL

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

获取特定的退订链接:
{api-domain}/crm/{version}/settings/unsubscribe_links/{link_id}

标题

授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope= ZohoCRM.settings.unsubscribe_links.READ

示例请求

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

响应 JSON 键

  • name string

    退订链接的名称。

  • id string

    退订链接的唯一ID。

  • created_time datetime

    退订链接创建的日期和时间。

  • created_byJSON object

    创建退订链接的用户详细信息。

  • modified_time datetime

    取消订阅链接最后修改的日期和时间。

  • modified_byJSON object

    最后修改退订链接详情的用户信息。

  • page_type string

    表示退订页面是由Zoho CRM设计的标准页面,还是自定义网页。可能的值是standard和custom。

  • custom_location_urlstring

    表示自定义网页,其中托管了退订链接。如果链接托管在标准的Zoho设计的网页中,则该值将为null。

  • standard_page_messagestring

    将在标准退订页面上显示的消息,以及退订链接。

  • submission_action_typestring

    表示用户点击取消订阅按钮时要执行的操作。根据链接的配置方式,值可以是display_message或redirect。

  • submission_redirect_url string

    表示用户点击取消订阅链接后将被重定向到的网页URL。

  • submission_message string

    用户点击取消订阅按钮后显示的消息。

可能的错误

  • INVALID_URL_PATTERNHTTP 404

    请检查尝试访问的URL是否正确
    解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方法:客户端没有所需的OAUTH范围。创建一个具有有效范围的新客户端。有关更多详细信息,请参阅上面的范围部分。

  • INTERNAL_ERRORHTTP 500

    内部服务器错误
    解决方法:服务器中出现意外且未处理的异常。请联系支持团队。

  • INVALID_REQUEST_METHODHTTP 400

    HTTP 请求方法类型无效
    解决方案:您指定了一个无效的 HTTP 方法来访问 API URL。请指定一个有效的请求方法。请参阅上面的端点部分。

示例响应

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"
        }
}