Zoho crm Logo

获取重复检查选项

目的

获取在您的账户中配置的重复检查偏好选项。

端点

  • GET /settings/duplicate_check_preference?module={module_api_name}

Request 详情

Request URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

scope = ZohoCRM.settings.ALL  (或者)
scope = ZohoCRM.settings.duplicate_check_preference.{operation_type} 

Possible operation types

ALL - 完全数据访问 
READ - 获取重复记录检查偏好 

支持的模块

Leads 

参数

  • 模块字符串,必填

    表示您要检索其重复检查偏好设置详细信息的模块。 支持的模块:潜在客户。 

样本请求

响应JSON键

 

您可以检索以下重复检查偏好设置配置:

  • converted_records (在UI中转换的潜在客户) - 系统将始终使用唯一字段(例如,电子邮件)检查所有潜在客户的重复项。
  • mapped_module_records (在UI中的联系人) - 系统将使用映射字段在联系人模块中检查重复项。

"type" : "converted_records"(转换的潜在客户)的响应JSON键

  • duplicate_check_preferenceJSON对象

    代表潜在客户模块中的重复记录检查偏好详情。

    • type 字符串

      代表重复记录检查偏好的类型。在这里,它是"converted_records",即转换的潜在客户。

    • type_configurationsJSON数组

      代表配置类型。

Response JSON 键值对 "type" : "mapped_module_records" (联系人)

如果为联系人(mapped_module_records)启用了重复检查偏好设置,那么响应将如下所示。

  • duplicate_check_preferenceJSON对象

    代表"联系人"模块中重复记录检查偏好的详细信息。

  • 类型字符串

    代表重复记录检查偏好的类型。在这里,它是"mapped_module_records"  即,联系人。

  • type_configurationsJSON array

    代表配置类型。

    • 字段映射JSON 数组

      代表在潜在客户和联系人模块中的唯一字段映射。

      • current_fieldJSON 对象

        代表在潜在客户模块中映射到联系人模块中的唯一字段。

        • api_name字符串,必填

          代表在潜在客户模块中唯一字段的API名称。

        • id字符串

          代表在潜在客户模块中唯一字段的ID。

      • mapped_fieldJSON 对象

        代表在联系人模块中的唯一字段,这些字段被映射到潜在客户模块的唯一字段。

        • api_name字符串

          代表在联系人模块中唯一字段的API名称。

        • id字符串

          代表在联系人模块中唯一字段的ID。

    • mapped_moduleJSON 对象

      表示映射模块的详细信息,即Leads模块中的唯一字段映射到的模块。在这种情况下,联系人模块。

      • api_name字符串

        表示映射模块的API名称。

      • id字符串

        表示映射模块的ID。

可能的错误

  • INVALID_REQUEST_METHODHTTP 400

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

  • NOT_SUPPORTEDHTTP 400

    API不支持指定的模块 
    解决方案: 请指定一个有效的模块。支持的模块:Leads

  • OAUTH_SCOPE_MISMATCHHTTP 401

    未经授权
    解决方案:客户端没有有效的范围来检索重复检查偏好选项。创建一个具有所需范围的新令牌。请参考上面的范围部分。

  • AUTHENTICATION_FAILUREHTTP 401

    身份验证失败
    解决方案:在API调用的请求头中传递访问令牌。

  • NO_PERMISSIONHTTP 403

    无权限访问该模块
    解决方案:联系管理员。

  • INVALID_URL_PATTERNHTTP 404

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

  • INTERNAL_ERRORHTTP 500

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

"类型":"转换记录"的样本响应

对于 "type" : "mapped_module_records" 的样本响应