更新评分规则
目的
要更新您Zoho CRM 组织中现有评分规则的各种属性,例如名称、描述和规则。
端点
- PUT /settings/automation/scoring_rules
- PUT /settings/automation/scoring_rules/{rule_ID}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/automation/scoring_rules
要更新特定评分规则:
{api-domain}/crm/{version}/settings/automation/scoring_rules/{rule_ID}
支持的模块
线索、Account、联系人、交易和自定义
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM。设置.评分规则.{operation_type}
可能的操作类型
全部 - 完全访问评分规则
Update - Update评分规则
注意
- 可以通过 API 更新评分规则的名称和描述。同时也可以新增字段规则和信号规则,以及更新或删除已有的字段规则和信号规则。
- 输入内容中包含的与模块、布局或状态相关的任何键都会被忽略,且无法被更新。这意味着您无法通过此 API 更改评分规则所关联的模块或布局,也无法修改其激活或未激活状态。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/scoring_rules"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d @updaterules.json
-X PUT输入 JSON
- id字符串,必填
表示要更新的规则的唯一ID。
- name字符串,可选
表示评分规则的唯一名称。该字段的最大长度为25个字符。
- description字符串,可选
表示规则的描述。此字段的最大长度为500个字符。
- field_rulesJSON 数组,可选
表示计分规则的字段规则。
- score数字,可选
表示为特定规则分配的分数。该键的取值范围为 -100 到 100。
- 条件JSON 对象, 可选
表示标准的详细信息,包括:
- group_operator字符串,可选
用于组合条件的逻辑运算符。可能的取值为 and 或 or。
- groupJSON 数组, 可选
定义评分条件的条件对象数组。每个条件必须包含:
- fieldJSON 对象, 可选
指定要评估的字段。
- comparator 字符串字符串, 必填
比较运算符。支持的运算符包括 equals(等于)、starts_with(开头是)、in(属于)、not_equal(不等于)、greater_equal(大于等于)、greater_than(大于)、less_equal(小于等于)、less_than(小于) 和 between(介于...之间)。
- value字符串, 必填
用于与字段值进行比较的值。
- Signal_rules JSON 数组, 可选
为评分规则定义的Signal规则。每个Signal规则必须包含:
- score数字,可选
分配给该Signal规则的分数。该键的取值范围为 -100 到 100。
- SignalJSON 对象,可选
表示Signal的详细信息。你可以通过 Signals API 获取Signal的详细信息。
- namespace字符串,可选
Signal的命名空间。
- id字符串,可选
Signal的唯一标识符。
- custom_fieldsJSON 数组,可选
一个自定义字段对象的数组,允许用户在记录中创建新字段或将得分映射到已有字段。每个自定义字段包括:
- field_label字符串,可选
自定义字段在用户界面中显示的标签。如果你想使用已有字段,请填写对应字段的标签。
- reference_fieldJSON 对象,可选
将自定义字段映射到指定得分。
- api_name字符串,可选
你想要映射的得分的 API 名称。可选值有 Positive_Score、Negative_Score、Touch_Point_Score、Touch_Point_Positive_Score、Touch_Point_Negative_Score 和 Score。
注意
要删除字段规则、信号规则或自定义字段,请在输入JSON的相应数组中包含_delete键,并指定您希望删除的规则或自定义字段的ID。请参阅示例输入部分以获取更多详情。
示例输入
Copied{
"scoring_rules": [
{
"name": "Leads Rule Test",
"id": "4876876000000945002",
"description": "SR for Leads",
"field_rules": [
{
"score": 5,
"criteria": {
"group_operator": "or",
"group": [
{
"group_operator": "AND",
"group": [
{
"field": {
"api_name": "Company"
},
"comparator": "equal",
"value": "Villa Margarita"
},
{
"field": {
"api_name": "Phone"
},
"comparator": "equal",
"value": "5555555555"
}
]
},
{
"field": {
"api_name": "Designation"
},
"comparator": "equal",
"value": "review"
}
]
}
},
{
"id": "4876876000009019407",
"score": 7,
"criteria": {
"group_operator": "and",
"group": [
{
"group_operator": "OR",
"group": [
{
"field": {
"api_name": "Company"
},
"comparator": "equal",
"value": "Zylker"
},
{
"field": {
"api_name": "Phone"
},
"comparator": "equal",
"value": "123456890"
}
]
},
{
"field": {
"api_name": "Designation"
},
"comparator": "equal",
"value": "Executive Secretary"
}
]
}
},
{
"id": "4876876000009019427",
"_delete": null
}
],
"signal_rules": [
{
"id": "4876876000009028119",
"score": 8
},
{
"id": "4876876000009028118",
"_delete": null
},
{
"score": -15,
"signal": {
"namespace": "EmailInsight_Bounce__s",
"id": "4876876000000112023"
}
}
],
"custom_fields": [
{
"field_label": "Touchpoint Negative Score",
"reference_field": {
"api_name": "Touch_Point_Positive_Score"
}
},
{
"id": "4876876000009028059",
"_delete": null
}
]
}
]
}可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP PUT 方法调用此 API。使用其他请求方法将导致此错误。 - INVALID_DATAHTTP 400
您指定的规则名称长度超过25个字符,或描述长度超过500个字符
解决方法:请将名称和描述分别控制在25个字符和500个字符以内。 - MANDATORY_NOT_FOUNDHTTP 400
您未在输入中指定一个必填字段
解决方法:请填写所有必填字段。请参阅输入JSON键部分以了解更多信息。 - DUPLICATE_DATAHTTP 400
具有指定条件或相同名称的评分规则已存在。
解决方法:具有指定条件或相同名称的评分规则已存在。请为该规则指定不同的条件或名称。 - INVALID_DATAHTTP 400
所提供的ID似乎无效
解决方法:您指定了无效的规则ID。请在请求体中指定有效的规则ID。 - ALREADY_USED HTTP 400
指定的条件已在相同规则的不同索引中给出。
解决方法:请指定不同的条件。 - NOT_SUPPORTEDHTTP 400
您已为非人员模块指定了Sign规则。非人员模块不支持Sign规则。
解决方法:请为指定模块使用字段规则。 - INVALID_DATAHTTP 400
您为 score 键指定了一个无效的值
解决方法:请为该键指定一个有效的值。请参阅输入JSON键部分以获取更多详情。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于调用此 API 的访问令牌不具有所需的权限范围。
解决方法: 生成一个具有此 API 所需权限范围的新访问令牌。请参考本页开头的“权限范围(Scope)”部分,获取所需权限范围的列表。 - NO_PERMISSIONHTTP 403
您没有权限更新评分规则。
解决方法:该用户没有权限更新评分规则。请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定有效的请求URL。更多详情请参阅本页开头的请求URL部分。 - INTERNAL_ERRORHTTP 500
服务器内部错误
解决方法:服务器中发生了意外且未处理的异常。请联系支持团队。
示例回复
Copied{
"scoring_rules": [
{
"code": "SUCCESS",
"details": {
"id": "4876876000000945002"
},
"message": "scoring rule updated successfully",
"status": "success"
}
]
}