Zoho crm Logo

更新退订链接

目的

要更新退订链接。

端点

  • PUT /settings/unsubscribe_links/{unsubscribe_link_id}

请求详情

请求 URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope = ZohoCRM.settings.unsubscribe.ALL(全部退订)
(或)
scope = ZohoCRM.settings.unsubscribe.UPDATE(更新退订)

样品请求

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

输入 JSON 键

  • name字符串,必填

    退订链接的唯一名称。

  • page_type字符串,必填

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

  • custom_location_URL字符串,如果page_type的值为custom时为必填项

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

  • standard_page_message字符串,可选

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

  • submission_action_type字符串,必填

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

  • submission_redirect_URL字符串,当submission_action_type的值为redirect时必填

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

  • submission_message字符串,当 submission_action_type 的值为 display_message 时为必填项

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

示例输入

Copied{
  "unsubscribe_links": [
    {
      "name": "TestY",
      "page_type": "custom",
      "custom_location_url": "https://custompage.com",
      "submission_action_type": "display_message",
      "submission_message": "<p style='max-width:100%;line-height:1.25;overflow-wrap:break-word;text-align:left'><span editable='false' data-image='' style='white-space:break-spaces;color:rgb(51, 51, 51);white-space-collapse:break-spaces;text-wrap:wrap;background:url(https://static.zohoCDN.com/crm/CRMClient/images/successalert_f194f7d_.svg) 0px 0px no-repeat;width:22px;height:22px;display:inline-block;vertical-align:middle;margin-right:7px;margin-inline-end:7px'> </span><span style='font-size:24px;font-weight:bold;vertical-align:middle;display:inline'>Unsubscribed Successfully</span><span> </span></p><p><span> </span></p><p><span style='display:inline'>You have successfully unsubscribed. Thank you for your time!</span></p>"
    }
  ]
}

可能的错误

  • INVALID_URL_PATTERNHTTP 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。

  • MANDATORY_NOT_FOUNDHTTP 400

    未找到必填字段 
    解决方法:您在输入内容中未指定一个或多个必填键。请指定所有必填键。有关详细信息,请参阅输入 JSON 键部分。

  • DUPLICATE_DATAHTTP 400

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

  • DEPENDENT_FIELD_MISSINGHTTP 400

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

  • INVALID_DATAHTTP 400

    提供的退订链接ID不属于该组织 
    解决方法:您指定了无效的退订链接ID。请指定一个有效的链接ID。

示例回复

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