更新重复检查选项
目的
要更新您账户中之前已启用的 重复检查选项。
端点
- PUT /settings/duplicate_check_preference?module={module_api_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/duplicate_check_preference
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
作用域 = ZohoCRM.settings.ALL(或)
作用域 = ZohoCRM.settings.duplicate_check_preference.{operation_type}
可能的操作类型
全部 - 完整数据访问
更新 - Update 重复记录检查偏好设置
支持的模块
潜在客户
参数
- module(模块)字符串,必填
表示要更新重复检查偏好设置的模块 API 名称。支持的模块:线索(Leads)。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/duplicate_check_preference?module=Leads"
-X PUT
-d "input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxd"输入 JSON 键用于"type" : "mapped_module_records"(联系人)
- duplicate_check_preferenceJSON 对象,必填
表示“联系人”模块中重复记录检查偏好的详细信息。
- 类型字符串,必填
表示重复记录检查偏好类型。这里是“mapped_module_records”,即联系人。
- type_configurationsJSON 数组,必填
表示配置类型。
- 字段映射JSON 数组,必填
表示潜在客户和联系人模块中的唯一字段映射。
- current_fieldJSON 对象,必填
表示线索模块中唯一字段与联系人模块中唯一字段的映射关系。
- mapped_fieldJSON 对象,必填
表示联系人模块中与潜在客户模块中唯一字段映射的唯一字段。
- api_name字符串,必填(映射唯一字段时,唯一字段的ID或API名称必须填写其一)
表示联系人模块中唯一字段的API名称。使用获取字段元数据(GET Fields Metadata)以检索唯一字段的API名称。
- id字符串,必填(映射唯一字段时,唯一字段的ID或API名称必须填写其一)
表示联系人模块中唯一字段的ID。使用获取字段元数据(GET Fields Metadata)以检索唯一字段的ID。
- mapped_moduleJSON 对象, 可选
表示已映射模块的详细信息,即线索模块中的唯一字段所映射到的模块。本例中为联系人模块。
用于更新 "type" : "mapped_module_records" 的重复检查偏好设置的示例输入
Copied{
"duplicate_check_preference": {
"type": "mapped_module_records",
"type_configurations": [
{
"field_mappings": [
{
"mapped_field": {
"api_name": "Phone", //The email unique field in Contacts has been replaced with the phone unique field and mapped successfully.
"name": "Contacts",
"id": "2423488000000000449"
},
"current_field": {
"api_name": "Phone",
"name": "Leads", //The email unique field in the Leads module has been replaced with the phone unique field and mapped successfully.
"id": "2423488000000000563"
}
}
],
"mapped_module": {
"api_name": "Contacts",
"name": "Contacts",
"id": "2423488000000000129"
}
}
]
}
}可能的错误
- INVALID_DATA HTTP 400
- 输入中给定的模块 API 名称似乎无效
解决方法:请指定有效的模块 API 名称。使用 获取模块元数据 API 来获取模块 API 名称。 - 给定的字段 ID 或 API 名称似乎无效
解决方法:请指定唯一字段的有效唯一 ID 或 API 名称,可使用 获取字段元数据 API。 - 给定的字段 ID 或 API 名称似乎无效
解决方法:请指定正确的唯一字段和其他字段的 ID 或 API 名称。可通过 获取模块元数据 API 和 获取字段元数据 API 来获取这些信息。 - 无效数据
解决方法:
- 输入中给定的模块 API 名称似乎无效
- NOT_SUPPORTEDHTTP 400
此 API 不支持指定的模块
解决方法:请指定受支持的模块。受支持的模块:线索 - FEATURE_NOT_SUPPORTEDHTTP 400
在 "mapped_module" 键中指定的模块不支持此功能
解决方法:请指定一个有效的模块。支持的模块:联系人 - NOT_ALLOWEDHTTP 400
指定的唯一字段用于映射的 API 名称或 ID 不是有效的唯一字段 API 名称
解决方法:- 仅指定用于映射的唯一字段。
- 仅指定唯一字段的 ID 或 API 名称,可使用 GET - 字段元数据 API。
- AMBIGUITY_DURING_PROCESSINGHTTP 400
- 在处理请求时出现歧义
解决方法:在发送请求前请核查输入字段。请参考上方的示例输入部分。 - 发现了两个不同的CRM字段
解决方法:您尝试映射的字段似乎不同。请只映射有效且唯一的字段。
- 在处理请求时出现歧义
- DEPENDENT_FIELD_MISSINGHTTP 400
- MANDATORY_NOT_FOUND HTTP 400
缺少必填字段
解决方法:请填写所有必填字段。请参考上方的示例输入部分。 - INVALID_REQUEST_METHODHTTP 400
HTTP 请求方法类型无效
解决方法:你为访问 API URL 指定了无效的 HTTP 方法。请指定一个有效的请求方法。请参考上面的端点部分。 - EXPECTED_FIELD_MISSINGHTTP 400
缺少一个或多个预期字段
解决方法:请填写所有必填字段。请参考上方的示例输入部分。 - REQUIRED_PARAM_MISSING HTTP 400
所需参数RAM缺失
解决方法:请指定您尝试更新重复检查选项的模块 API 名称。支持的模块:线索(Leads)。
- OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方法:客户端没有更新重复记录检查选项的有效权限。请创建一个具有所需权限的新令牌。请参考上方的权限部分。 - AUTHENTICATION_FAILURE HTTP 401
Authentication失败
解决方法:在 API 调用的请求头中传递访问令牌。 - NO_PERMISSIONHTTP 403
没有权限访问该模块
解决方法:请联系管理员。 - INVALID_URL_PATTERN HTTP 404
请检查尝试访问的URL是否正确
解决方法:指定的请求URL不正确。请指定一个有效的请求URL。请参考上文的请求URL部分。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方案:服务器出现了意外且未处理的异常。请联系支持团队。
示例回复
Copied{
"duplicate_check_preference": {
"code": "SUCCESS",
"details": {},
"message": "Field mapping updated successfully.",
"status": "success"
}
}