更新记录锁定配置
目的
更新不同模块的记录锁定配置。
端点
- PUT /settings/record_locking_configurations?module={module_API_name}
- PUT /settings/record_locking_configurations/{record_locking_config_ID}?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/record_locking_configurations?module={module_API_name}
要更新单个记录锁定配置ID:
{api-domain}/crm/{version}/settings/record_locking_configurations/{record_locking_config_ID}?module={module_API_name}
支持的模块
潜在客户、联系人、Account、商机、报价、Sales Orders、采购Orders、Invoices、Vendors、价目表、案例、解决方案、任务、产品以及自定义模块
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.record_locking_configurations.Update
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/record_locking_configurations?module=Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X PUT参数
- module字符串,必填
指定要更新其记录锁定配置的模块的 API 名称。
注意
- 对于自定义模块,只有由用户创建的模块才支持记录锁定。通过扩展、集成或其他方式创建的自定义模块不支持记录锁定。
输入JSON键
- locked_for字符串,可选
指定记录是对所有用户档案锁定,还是对所有用户档案(有少数例外)锁定。
可能的取值: all_profiles_except_excluded_profile,all_profiles。
默认值: all_profiles。 - excluded_fieldsJSON 数组,可选
指定不参与记录锁定的字段。
- api_name字符串
指定不参与记录锁定字段的 API 名称。
- id 长整型
指定不参与记录锁定字段的 ID。
- feature_type字符串,可选
指定记录锁定配置的功能类型。
- locking_rulesJSON 数组,当 "lock_type" 为 "both" 或 "automatic" 时必填
指定用于自动锁定模块中记录的规则详细信息。
- 名称字符串
指定记录锁定规则的名称。
- idlong
指定记录锁定规则的ID。
- lock_existing_records布尔值,可选
指定是否必须锁定现有记录。
- 条件JSON 对象,必填
指定记录锁定规则的条件。
- group_operator
指定在条件中使用的分组运算符(例如:AND,OR)。
- group JSON 数组
表示记录锁定规则的条件分组。
- comparator
表示条件中使用的比较运算符。
- field JSON 对象
表示用于条件筛选的字段详情。
- api_namestring
指定字段的API名称。
- idlong
指定字段的ID。
- valuestring
指定条件中使用的值。
- restricted_actionsJSON 数组,可选
指定对已锁定记录受限制的操作。可能的取值:update(更新)、tags(标签)、convert(转换)、delete(删除)、change_owner(更改所有者) 默认值:update(更新)
- lock_for_portal_users布尔值,可选
指示锁定的记录是否同样对门户用户受限。默认值:true
- restricted_communicationsJSON 数组, 可选
指定对已锁定记录限制的通信类型。
可能的值: send_mail - lock_type字符串,必填
表示记录锁定配置的类型。
可能的取值: manual(手动)、automatic(自动)、both(两者)。
当锁定类型为 automatic(自动)时,如果在创建或更新记录时满足指定条件,记录将被自动锁定。当锁定类型为 manual(手动)时,具有锁定权限的用户可以手动锁定记录。 - restricted_custom_buttonsJSON 数组,可选
表示对于被锁定记录受限的自定义按钮。
- name字符串
表示对于被锁定记录受限的自定义按钮的API名称。
- id长整型
表示对于被锁定记录受限的自定义按钮的ID。
- lock_excluded_profilesJSON 数组,当 locked_for 的值为 "all_profiles_except_excluded_profiles" 时为必填项
表示被限制锁定的配置文件。
- api_name
表示被限制锁定的配置文件的 API 名称。
- id long
表示被限制锁定的配置文件的 ID。
注意
- 当条件中只给出 api_name 或 id 其中一个有效时,记录将以有效的值进行处理。
- 可以使用 Update 记录锁定 API 来添加、修改或删除锁定规则。当输入内容中指定锁定规则 id 时,对应的锁定规则将被Edit。当未指定 id 时,则视为新规则。当 "_delete" 键的值为 true 时,该锁定规则将被删除。
- Edit 操作在记录锁定配置中始终受限。即在 restricted_actions 中,Update 一值总会存在。
示例输入
Copied{
"record_locking_configurations": [
{
"locked_for": "all_profiles_except_excluded_profiles",
"excluded_fields": null,
"locking_rules": [
{
"id": "5843104000000766010",
"_delete": true
},
{
"name": "email rule 34",
"id": "5843104000000766034",
"lock_existing_records": false,
"criteria": {
"comparator": "equal",
"field": {
"api_name": "Email",
"id": "5843104000000002599"
},
"value": "test@gmail.com"
}
},
{
"name": "email rule 5",
"lock_existing_records": false,
"criteria": {
"comparator": "equal",
"field": {
"api_name": "Email",
"id": "5843104000000002599"
},
"value": "test5@gmail.com"
}
}
],
"restricted_actions": null,
"lock_for_portal_users": true,
"restricted_communications": [
"send_mail"
],
"system_defined": false,
"lock_type": "both",
"restricted_custom_buttons": [
{
"name": "Send with Zoho Sign",
"id": "5843104000000485570"
}
],
"lock_excluded_profiles": [
{
"name": "Administrator",
"id": "5843104000000026011"
}
]
}
]
}可能的错误
- REQUIRED_PARAM_MISSINGHTTP 400
缺少一个预期的参RAM数。
解决方法: 响应中的 "details" 键会指出请求中缺失的参RAM数。请确保在 "参RAM数" 部分包含所有标记为“必填”的参RAM数。 - INVALID_MODULEHTTP 400
提供的模块名称似乎无效。
解决方法:请指定一个有效的模块 API 名称。 - NOT_SUPPORTEDHTTP 400
- 所提供的模块不被支持。
- 条件中指定的 API 名称不被支持。
- 条件中指定的值不被支持。
- 对于任务模块,api_name 为 task status 且值为 closed 是唯一被接受的值。任何其他条件都会出现此错误。
- 条件中的字段不被支持。
- 条件中的值不被支持。
解决方案:请指定相应的支持值。
- FEATURE_NOT_SUPPORTEDHTTP 400
当前用户版本不支持记录锁定配置。
- INVALID_DATAHTTP 400
- 在记录锁定规则条件中指定的 API 名称无效。
- feature_type 不是 record_locking。
- 在请求体中提供的 restricted_communications 的值无效。有效值为 send_mail, send_survery, send_portal_invitation。
- 在请求体中提供的 restricted_actions 的值无效。有效值为 convert, update, delete, change_owner, tags。
- 为 restricted_button 提供的值无效。
- 在请求体中提供的 lock_type 的值无效。有效值为 manual, automatic 或 both。
- 在请求体中提供的 locked_for 的值无效。有效值为 all_profiles 或 all_profiles_except_excluded_profiles。
- 为 lock_excluded_profiles 提供的值无效。
- 为 excluded_fields 提供的值无效。
解决方法:请在请求中指定对应的有效值。
- LIMIT_EXCEEDEDHTTP 400
- 已超出锁定规则的最大限制。
- 已超出自定义按钮的最大限制。
- 已超出排除字段的最大限制。
- 已超出排除配置文件的最大限制。
- 尝试添加锁定规则配置时,该配置已存在。
解决方法:请参考响应中的“details”键以了解 available_limit,并修改请求体。
- MANDATORY_NOT_FOUNDHTTP 400
- 必填字段 lock_type 未提供。
- 必填字段 lock_reason 未提供。
解决方法:在请求体中提供所有必填字段。
- EXPECTED_FIELD_MISSINGHTTP 400
记录锁定规则的条件中缺少字段的 ID 或 API 名称。
解决方法:请在条件中提供必要的字段。 - AMBIGUITY_DURING_PROCESSINGHTTP 400
条件中用于记录锁定规则的字段的ID和API名称属于不同的字段。
解决方法: 请提供具有正确API名称和ID的条件。 - DEPENDENT_FIELD_MISSINGHTTP 400
- 当 lock_type 为 both 或 automatic 时,请求体中未提供 locking_rules 键。
- 当 locked_for 的值为 all_profiles_except_excluded_profiles 时,请求体中未提供 lock_excluded_profiles 键。
解决方法: 在请求体中提供所需的依赖字段。
- DUPLICATE_DATAHTTP 400
- 在条件中发现重复值
- 在规则名称中发现重复值
解决方案:为相应字段提供唯一值。
- INVALID_REQUEST_METHODHTTP 403
HTTP请求方法类型无效
解决方法:您为访问API URL 指定了无效的HTTP方法。请指定有效的请求方法。请参考上方的端点部分。 - NO_PERMISSIONHTTP 403
无权自定义记录锁定配置。用户没有权限。
解决方法:请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方法:服务器中出现了意外且未处理的异常,请联系支持团队。
示例回复
Copied{
"record_locking_configurations": [
{
"code": "SUCCESS",
"details": {
"id": "5843104000000758004"
},
"message": "record locking configuration updated successfully",
"status": "success"
}
]
}