添加领土
目的
将新的领域添加到您的Zoho CRM组织。
端点
- POST /settings/territories
Request 详细信息
Request URL
{api-domain}/crm/{version}/settings/territories
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.territories.{operation_type}
可能的操作类型
ALL - 对领土的全面访问
CREATE - 创建领土
样本请求
在请求中,“@addterritories.json”包含了样本输入数据。
输入 JSON
- 名称 字符串,必填
代表领土的名称。
- reporting_to JSON 对象,必填
代表父级领土的ID。这可以从 GET 领土API获取
- 经理 JSON 对象,可选
代表领土的经理详细信息。您可以给出领土经理的ID。使用获取用户API来获取您想设置为领土经理的用户的ID。
- permission_type 字符串,必填
代表了领土的权限类型。有效值为read_only和read_write_delete。
- 描述 字符串,可选
代表领土的描述。
- account_rule_criteria JSON 对象,可选
代表账户模块领土规则的标准。
- 比较器 字符串,可选
代表账户规则条件的比较运算符(例如,大于,小于)。
- fieldJSON 对象,可选
代表账户规则条件的字段详细信息。
- api_name 字符串,可选
代表账户规则条件的字段的API名称。
- id 字符串,可选
代表账户规则条件的字段的唯一ID。这可以从字段元数据API获取。
- 值 字符串,可选
代表用于账户规则条件比较的值。
- lead_rule_criteria JSON 对象,可选
代表领域中潜在客户规则的标准。
- 比较器 字符串,可选
代表领导规则标准的比较运算符(例如,大于,小于)。
- 字段 JSON 对象,可选
代表潜在客户规则条件的字段详细信息。
- api_name 字符串,可选
代表潜在客户规则条件的字段的API名称。
- id 字符串,可选
代表潜在客户规则条件的字段的唯一ID。这可以从字段元数据API获取
- 值 字符串,可选
代表用于领导规则标准比较的值。
- deal_rule_criteria JSON 对象,可选
代表领土中交易规则的标准。
- 比较器 字符串,可选
代表交易规则条件的比较运算符(例如,大于,小于)。
- 字段 JSON 对象,可选
代表交易规则条件的字段详细信息。
- api_name 字符串,可选
代表交易规则条件的字段的API名称。
- id 字符串,可选
代表交易规则条件的字段的唯一ID。这可以从字段元数据API获取。
- 值 字符串,可选
代表用于交易规则条件比较的值。
注意
以下部分描述了字段类型及其允许的比较器
文本,下拉列表,查找
等于,不等于,包含,不包含,以...开始,以...结束
- 支持的日期字面量及其比较器
- 日期字面量 今天 明天 明天加(从明天开始) 昨天 天数 年龄天数 空 比较器 等于
- 日期字面量 昨天减(直到昨天) 比较器 小于等于
- 日期字面量 非空 比较器 不等于
- 日期字面量 上个月 本月 下个月 上周 本周 去年 今年 明年 上个财季 (FQ - 财务季度) 本财季 下财季 上财年 (FY - 财务年度)本财年 下财年 比较器 之间
- 每个条件支持的规则最大数量为25
- 您的组织中可以创建的领土数量取决于CRM的版本
- 一次API调用中可以添加的领土最大数量为10
样本输入
可能的错误
- LIMIT_EXCEEDEDHTTP 400
- 已达到最大领土限制
- 已达到领土的最大用户限制
- 已达到最大领土条件限制
解决方案:请参考响应中的"details"键,查找输入中出错的字段的API名称。
- DUPLICATE_DATA HTTP 400
- 请求体中给出的领土名称已经存在
- 请求体中存在重复的领土名称。
解决方案:在请求体中为不同的领土指定唯一的领土名称。
- MANDATORY_NOT_FOUND HTTP 400
键名,reporting_to和permission_type是必需的参数。
解决方案: 提供一个包含所有必需参数的有效json请求。 - NOT_ALLOWEDHTTP 400
- 非活跃用户
- 已删除用户
- 无效用户
解决方案:提供有效的用户ID
- INVALID_DATA HTTP 400
- 父级领土ID无效
- permission_type无效
- reporting_to ID无效
- 经理ID无效
- 领土名称无效。特殊字符 ^ ~ ` # % & + = [ ] { } | \ ; " ' < > , 不被允许。
- 给定的Criteria不是有效的JSON
解决方案:请参考响应中的"details"键,查找输入中出错的字段的API名称。 - FEATURE_NOT_ENABLEDHTTP 403
区域管理未启用
解决方案:启用区域管理功能后再试。 - PERMISSION_DENIEDHTTP 400
User does't have a permission to choose that territory as a Parent Id
Resolution: The user does not have permission to add that particular territory as a parent territory. Contact your system administrator.OAUTH_SCOPE_MISMATCHHTTP 401The access token you have used to make this API call does not have the required scope.
Resolution: Generate a new access token with the required scopes for this API. Refer to Scope section at the beginning of this page for the list of required scopes. - FEATURE_NOT_SUPPORTEDHTTP 403
标准版和专业版不支持领土特性
解决方案:联系您的管理员。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方案:指定一个有效的请求URL。请参考本页开头的URL部分以获取更多详细信息。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方案:联系support@zohocrm.com的支持团队。