更新地区
目的
要更新您Zoho CRM 组织中现有辖区的详细信息。
端点
- PUT /settings/territories
- PUT /settings/territories/{territory_ID}
请求详情
请求 URL
更新所有区域:
{api-domain}/crm/{version}/settings/territories
更新指定区域:
{api-domain}/crm/{version}/settings/territories/{territory_ID}
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.设置.区域.{operation_type}
可能的操作类型
全部 - 访问所有区域
更新 - 更新区域
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/territories"
-X PUT
-d "@updateterritories.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"在请求中,“@updateterritories.json”包含示例输入。
输入 JSON
- id 字符串,可选
表示区域的ID。如果在端点中未提及ID,则此项为必填项。
- 名称 字符串,可选
表示区域的名称。
- reporting_to JSON 对象,可选
表示父属区域的 ID。该信息可通过 获取区域 API 获得。
- manager JSON 对象,可选
表示此辖区的经理详细信息。您可以填写辖区经理的ID。使用 获取UsersAPI 获取您想要设置为辖区经理的用户ID。将 manager 字段设置为 null 可以从辖区中移除经理。
- permission_type 字符串,必填
表示该区域的权限类型。有效值为 read_only 和 read_write_delete。
- 描述 字符串, 可选
表示该区域的描述。
- account_rule_criteria JSON 对象,可选
表示
模块区域规则的标准。 - 比较器 字符串,可选
表示账户规则条件的比较运算符(例如,大于,小于)。
- fieldJSON 对象,可选
表示账户规则条件的字段详细信息。
- api_name 字符串,可选
表示账户规则条件字段的 API 名称。
- id 字符串,可选
表示账户规则条件字段的唯一 ID。该信息可通过 字段元数据 API 获取。
- 值 字符串,可选
表示用于与账户规则条件进行比较的值。
- lead_rule_criteria JSON 对象, 可选
表示区域中潜在客户规则的标准。
- comparator 字符串,可选
表示线索规则条件的比较运算符(例如,大于、小于)。
- field JSON 对象, 可选
表示线索规则条件的字段详细信息。
- api_name 字符串, 可选
表示线索规则条件字段的 API 名称。
- id 字符串, 可选
表示线索规则条件字段的唯一 ID。可以通过 字段元数据 API 获取。
- 值 字符串,可选
表示要用于线索规则条件进行比较的值。
- deal_rule_criteria JSON 对象, 可选
表示该区域中交易规则的标准。
- comparator 字符串,可选
表示交易规则条件的比较运算符(例如,大于、小于)。
- field JSON 对象,可选
表示交易规则条件的字段详细信息。
- api_name 字符串,可选
表示交易规则条件中字段的 API 名称。
- id 字符串,可选
表示交易规则条件中字段的唯一 ID。可通过 字段元数据 API 获取。
- value 字符串, 可选
表示要与交易规则条件进行比较的值。
注意
以下部分描述了字段类型及其允许使用的比较符
文本、选项列表、查找
等于、不等于、包含、不包含、开头为、结尾为
- 支持的日期字面量及其比较符
- 日期字面量 今天、明天、明天之后US(从明天开始)、昨天、天数龄、天数龄为空 比较符 等于
- 日期字面量 直到昨天US 比较符 小于等于
- 日期字面量 非空 比较符 不等于
- 日期字面量 上个月、本月、下个月、上周、本周、去年、今年、明年、上一个财季(FQ - 财务季度)、本财季、下一个财季、上一个财年(FY - 财务年度)、本财年、下一个财年 比较符 介于
- 每个条件内支持的最大规则数为 25 条
- 在您的组织中最多可创建的区域数量取决于CRM的版本
- 单次 API 请求最多可更新 10 个区域
示例输入
Copied{
"territories": [
{
"id": "431581000000798016",
"name": "Territory1234",
"reporting_to": {
"id": "431581000000272796"
},
"manager": null,
"permission_type": "read_only",
"description": null,
"account_rule_criteria": null,
"lead_rule_criteria": null,
"deal_rule_criteria": {
"comparator": "greater_than",
"field": {
"api_name": "Amount",
"id": "431581000000000799"
},
"value": "2000000"
}
}
]
}可能的错误
- LIMIT_EXCEEDEDHTTP 400
- 已达到最大区域数量限制
- 该区域已达到最大Users数量限制
- 已达到最大区域条件数量限制
解决方法:请参考响应中的“details”键,查找输入中出错字段的 API 名称。 - DUPLICATE_DATA HTTP 400
- 请求体中提供的区域名称已存在
- 请求体中存在重复的区域名称
解决方法:为请求体中的不同区域指定唯一的区域名称。
- MANDATORY_NOT_FOUND HTTP 400
- 键 name、reporting_to 和 permission_type 是必填参数
解决方法: 提供一个包含所有必填参数的有效JSON请求。 - manager 字段被设置为空JSON对象
解决方法: 为 manager 字段提供有效的值。
- 键 name、reporting_to 和 permission_type 是必填参数
- INVALID_DATA HTTP 400
- 父级区域 ID 无效
- permission_type 无效
- reporting_to ID 无效
- manager ID 无效
- 区域名称无效。不允许使用特殊字符 ^ ~ ` # % & + = [ ] { } | \ ; " ' < > , 。
- 给定的 Criteria 不是有效的 JSON
解决方案:请参考响应中的 "details" 键,以获取输入中出错字段的 API 名称。 - NOT_ALLOWEDHTTP 400
- 组织区域除了Name之外,无法更新
解决方法:您只能更新组织区域的Name,其他信息无法修改。 - 区域交易规则已禁用
解决方法:在区域交易规则被禁用时,您无法更新交易规则。 - 区域线索规则已禁用
解决方法:在区域交易规则被禁用时,您无法更新线索规则。
- 组织区域除了Name之外,无法更新
- PERMISSION_DENIEDHTTP 400
用户没有权限查看/访问该区域
解决方法:该用户没有权限更新区域。请联系系统管理员。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于此 API 调用的访问令牌不具备所需的权限范围
解决方法:生成一个具备此 API 所需权限范围的新访问令牌。请参阅本页面开头的权限范围部分,获取所需权限的列表。 - TERRITORY_NOT_ENABLEDHTTP 403
地区功能未启用
解决方法:尝试启用地区功能。 - TERRITORY_DISABLEDHTTP 403
区域功能未启用
解决方法:请尝试启用区域功能。 - INVALID_URL_PATTERN HTTP 404
请求的URL不正确
解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。 - INTERNAL_ERRORHTTP 500
服务器发生了意外且未处理的异常
解决方法: 请联系支持团队:support@zohocrm.com。
示例回复
Copied{
"territories": [
{
"code": "SUCCESS",
"details": {
"id": "431581000000798016"
},
"message": "Territory Updated Successfully",
"status": "success"
}
]
}