Zoho crm Logo

启用重复项检查选项

目的

在潜在客户模块中启用重复检查首选项。 

您可以按照以下步骤在 UI 中启用“重复检查首选项”选项:

  1. 转到设置。
  2. 选择自定义。
  3. 选择 模块和字段。
  4. 点击潜在客户模块。
  5. 右键单击潜在客户模块,并启用重复检查首选项选项。

有两 种类型可以配置重复检查首选项 : 
  i. 已转换的潜在客户 (converted_records)  
  ii. 联系人 (mapped_module_records)

 

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

请求详情

请求 URL

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

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

范围

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

可能的操作类型

ALL - 完全数据访问 
CREATE - 启用重复记录检查首选项

受支持的模块

潜在客户

参数

  • modulestring,必填

    表示要启用重复检查偏好设置的模块 API 名称。支持的模块:Leads。

    为避免重复条目,请在Leads模块中使用唯一字段值检查重复项。在Contacts模块中,将唯一字段进行映射,把 Leads 模块中的唯一字段与 Contacts 模块中的唯一字段对应起来,以在组织中交叉检查重复记录。 
     

样本请求

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/duplicate_check_preference?module=Leads"
-X POST
-d "@input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"

适用于 "type" : "converted_records" 的输入 JSON 键(已转换的潜在客户)


 系统将始终使用唯一字段检查所有潜在客户的重复记录。选中此选项后,还会对所有已转换的潜在客户进行重复检查。此配置适用于所有布局。

模块_API_更改
  • duplicate_check_preference JSON object,必填

    表示潜在客户模块中的重复记录检查首选项详细信息。

    • type string,必填

      表示重复记录检查首选项的类型。此处其值为“converted_records”,即已转换的潜在客户。

用于为 "type":"Converted Record" 启用重复项检查首选项的示例输入

Copied{
    "duplicate_check_preference": {
        "type": "converted_records"
    }
}

示例回应

Copied{
    "duplicate_check_preference": {
        "code": "SUCCESS",
        "details": {},
        "message": "Duplicate check enabled for converted_records successfully.",
        "status": "success"
    }
}

用于 "type" : "mapped_module_records" (联系人)的输入 JSON 键


 

选择此选项后,系统将检查重复项 在联系人模块中使用映射字段。

模块_API_更改
  • duplicate_check_preference JSON object

    表示 "Contacts" 模块中重复记录检查偏好设置的详细信息。

  • 类型 字符串,必填

    表示重复记录检查偏好设置的类型。在此,它为 "mapped_module_records"  即联系人。

  • type_configurations JSON array,必填

    表示配置类型。

    • field_mapping JSON array,必填

      表示线索和联系人模块中的唯一字段映射。

      • current_field JSON object,必填

        表示在潜在客户模块中与联系人模块中的唯一字段相映射的唯一字段。

        • api_name string,必填(映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

          表示在潜在客户模块中该唯一字段的 API 名称 。使用获取字段元数据 来检索唯一字段的 API 名称。

        • id string,必填(映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

          表示在潜在客户模块中该唯一字段的 ID。使用获取字段元数据 来检索唯一字段的 ID。

      • mapped_field JSON object,必填

        表示线索模块中的唯一字段映射到的联系人模块中的唯一字段。

        • api_name string,必填(映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

          表示联系人模块中唯一字段的 API 名称。使用 获取字段元数据  来检索唯一字段的 API 名称。

        • id string,必填(映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

          表示联系人模块中唯一的 ID字段。使用 获取字段元数据  来检索唯一字段的 ID。

    • mapped_module JSON object,必填

      表示已映射模块的详细信息,即将潜在客户(Leads)模块中的唯一字段映射到的模块。本例为联系人(Contacts)模块。

      • api_name string,必填(用于映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

        表示已映射模块的 API 名称。使用 获取模块元数据 来检索已映射模块的API 名称。(Contacts 模块的 API 名称)

      • id string,必填(用于映射唯一字段时,必须提供唯一字段的 ID 或 API 名称之一)

        表示已映射模块的 ID。使用 获取模块元数据 来检索已映射模块的 ID(Contacts 模块的 ID)。

用于启用重复检查偏好设置的示例输入,针对 "type" : "Mapped Module Records"

Copied{
    "duplicate_check_preference": {
        "type": "mapped_module_records",
        "type_configurations": [
            {
                "field_mappings": [
                    {
                        "current_field": {
                            "api_name": "Email",
                            "id": "2276164000000000563"
                        },
                        "mapped_field": {
                            "api_name": "Email",
                            "id": "2276164000000000449"
                        }
                    }
                ],
                "mapped_module": {
                    "api_name": "Contacts",
                    "id": "2423488000000000129"
                }
            }
        ]
    }
}

可能的错误

  • INVALID_DATA HTTP 400
    • 输入中提供的模块 API 名称似乎无效
      解决方法:请指定有效的模块 API 名称。使用 GET 模块元数据 API 获取模块 API 名称。
    • 提供的字段 ID 或 API 名称似乎无效
      解决方法:请使用 GET - 字段元数据 API 指定唯一字段的有效唯一 ID 或 API 名称。
    • 提供的字段 ID 或 API 名称似乎无效
      解决方法:请指定唯一字段和其他字段的正确 ID 或 API 名称。可使用 GET 模块元数据 API 和 GET 字段元数据 API 获取这些信息。
    • 无效数据
      解决方法:
      • 为 mapped_field、mapped_module 和 current_field 键指定有效的值。请参阅上面的 示例输入部分。
      • 为 mapped_field, mapped_module 和 current_field 键及其各自的字段指定有效的数据类型。请参阅上面的 示例输入部分。
  • NOT_SUPPORTED HTTP 400

    此 API 不支持指定的模块 
    解决方法: 指定受支持的模块。 支持的模块:Leads

  • ALREADY_CONFIGURED HTTP 400

    已配置
    解决方法: 您尝试启用的重复检查设置已经配置。

  • FEATURE_NOT_SUPPORTED HTTP 400

    在 "mapped_module" 键中指定的模块不支持该功能 
    解决方法: 请指定一个有效的模块。 支持的模块:Contacts

  • NOT_ALLOWED HTTP 400

    为映射指定的唯一字段的 API 名称或 ID 不是有效的唯一字段 API 名称。
    解决方法:

  • AMBIGUITY_DURING_PROCESSING HTTP 400
    • 处理请求时出现歧义
      解决方案: 在发送请求之前请验证输入字段。参阅上方的“示例输入”部分。
    • 发现两个不同的 CRM 字段
      解决方案: 您尝试映射的字段似乎不同。仅映射有效且唯一的字段。
  • DEPENDENT_FIELD_MISSING HTTP 400

    缺少依赖字段
    解决方案:

    • 指定所有必填字段。请参阅上方的示例输入部分。
    • 要为 Contacts 或 mapped_module_records 配置重复检查选项,必须使用 "type_configurations" JSON 数组来映射唯一字段。请参阅上方的示例输入部分。
  • MANDATORY_NOT_FOUND HTTP 400

    缺少必填字段
    解决方法: 请提供所有必填字段。请参阅上面的示例输入部分。

  • INVALID_REQUEST_METHOD HTTP 400

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

  • EXPECTED_FIELD_MISSING HTTP 400

    缺少一个或多个预期字段
    解决方案:请提供所有必填字段。请参考上面的示例输入部分。

  • REQUIRED_PARAM_MISSING HTTP 400

    缺少必需参数
    解决方案:

    请指定您尝试启用重复检查选项的模块的 API 名称。支持的模块:Leads。

  • OAUTH_SCOPE_MISMATCH HTTP 401

    未授权
    解决方法: 客户端没有用于启用重复记录检查选项的有效作用域。创建一个包含所需作用域的新令牌。请参阅上面的作用域部分。

  • AUTHENTICATION_FAILURE HTTP 401

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

  • NO_PERMISSIONHTTP 403

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

  • INVALID_URL_PATTERN HTTP 404

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

  • INTERNAL_ERROR HTTP 500

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

示例回应

Copied{
    "duplicate_check_preference": {
        "code": "SUCCESS",
        "details": {},
        "message": "Duplicate check enabled for mapped_module_records successfully.",
        "status": "success"
    }
}