Zoho crm Logo

创建退订链接

目的

要创建一个取消订阅链接,可用于您的电子邮件模板或电子邮件页脚。

端点

  • POST /settings/unsubscribe_links

请求详情

请求 URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope = ZohoCRM.settings.unsubscribe.ALL
(或)
scope = ZohoCRM.settings.unsubscribe.CREATE

示例请求

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

输入 JSON 键

  • name string,必填

    用于取消订阅链接的唯一名称。

  • page_type string,必填

    指定退订链接应托管在由 Zoho CRM 设计的标准页面,还是自定义网页。可选值为 standard 和 custom。

  • custom_location_URLstring,如果 page_type 的值为 custom,则为必填

    指定你希望托管退订链接的网页 URL。如果你希望使用标准页面来托管退订链接,请 Skip 此字段。

  • standard_page_messagestring,可选

    指定要在标准取消订阅页面上显示的消息。该消息可以是富文本(HTML)或纯文本格式。

  • submission_action_type string,必填

    指定当用户点击退订按钮时要执行的操作。可以配置为显示消息,或在退订时重定向到另一个 URL。可选值为 display_message 和 redirect。

  • submission_redirect_URLstring,当 submission_action_type 的值为 redirect 时为必填项

    指定用户在点击退订链接后将被重定向到的网页 URL。

  • submission_messagestring, 当 submission_action_type 的值为 display_message 时为必填

    当用户点击取消订阅按钮后要显示的消息。您可以以富文本(HTML)或纯文本格式指定该消息。

样例输入

Copied{
  "unsubscribe_links": [
    {
      "name": "Test",
      "page_type": "standard",
      "standard_page_message": " You will not be sent any more newsletter once you click the unsubscribe button. Do you wish to continue?",
      "submission_action_type": "redirect",
      "submission_redirect_url": "https://redirecturl.com"
    }
  ]
}

可能的错误

  • 无效_URL_模式HTTP 404

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

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未授权
    解决方案: 客户端没有所需的 OAuth 作用域。请生成具有有效作用域的新令牌。有关更多详细信息,请参阅上面的作用域部分。

  • INTERNAL_ERRORHTTP 500

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

  • INVALID_REQUEST_METHODHTTP 400

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

  • INVALID_DATAHTTP 400

    您为URL字段指定了无效的值。
    解决方法:指定有效的URL。

  • LIMIT_EXCEEDEDHTTP 400

    退订链接数量已超出限制 
    解决方法:您已在账户中设置了允许的退订链接数量上限。请删除一个或多个链接以创建更多链接。有关各版本限制的更多信息,请参阅此处。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必需字段 
    解决方法:您在请求正文中未指定一个或多个必需键。请指定所有必需键。有关详情,请参阅输入 JSON 键部分。

  • DUPLICATE_DATAHTTP 400

    退订链接名称已存在
    解决方案:为退订链接指定另一个唯一名称。

  • DEPENDENT_FIELD_MISSINGHTTP 400

    未找到必填字段 
    解决方法:您尚未指定其中一个依赖字段。请指定所有依赖字段。有关依赖字段的说明,请参阅上文的“输入 JSON 键”部分。

示例响应

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