将领土分配给记录
目的
将领土分配给多个记录或单个记录。
端点
- POST /{module_api_name}/actions/assign_territories
- POST /{module_api_name}/{record_ID}/actions/assign_territories
Request详情
Request URL
{api-domain}/crm/{version}/{module_api_name}/actions/assign_territories
为单个记录分配领土:
{api-domain}/crm/{version}/{module_api_name}/{record_ID}/actions/assign_territories
支持的模块
潜在客户,账户,联系人和交易
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{模块名称}.{操作类型}
可能的模块名称
潜在客户,账户,联系人和交易
可能的操作类型
ALL - 对记录的完全访问
UPDATE - 在模块中更新记录
样本请求
Request JSON 键
- id字符串,如果在URL中未指定,则必填
代表您想要分配领土的交易、账户或联系人的唯一ID。
- TerritoriesJSON 数组,必填
数组中的每个 JSON 对象代表您想要分配给记录的领土的唯一ID。使用 Get Territories API 获取可用领土及其各自的唯一ID的列表。
注意
- 您只能为一笔交易分配一个领域。
- 您可以为潜在客户、联系人或账户分配最多10个领域。
样本输入
Response JSON 键
- codestring
代表Response代码。"SCHEDULED" 表示已成功安排作业以分配领土。
- detailsJSON 对象
- id-string - 代表您要分配领土的记录的 ID。
- job_id-string - 代表安排分配领土给记录的作业的 ID。在获取特定功能信息 API 中使用记录 ID 获取该记录的计划作业的详细信息。
可能的错误
- ALREADY_SCHEDULEDHTTP 400
您正在尝试再次为记录分配领土,而一个任务已经被安排了。
解决方案:安排任务后,使用获取特定功能信息 API来查看该记录的已安排任务的状态。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上述端点部分。 - RECORD_LOCKEDHTTP 400
您无法执行此操作,因为记录已被锁定。
解决方案:请等待记录解锁。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来更新记录
解决方案:用户没有更新记录的权限。请联系您的系统管理员。 - LIMIT_EXCEEDEDHTTP 400
该记录的领土最大限制超过
解决方案:您只能为一个联系人和一个账户分配最多十个领土,以及为一个交易分配一个领土。 - INVALID_DATAHTTP 400
给出的记录ID似乎无效
解决方案:请求输入中指定的记录ID错误。使用获取记录API来获取可用记录及其各自的唯一ID。在请求输入中指定有效的记录ID。 - INVALID_DATAHTTP 400
给出的id似乎无效
解决方案:您指定的领土ID不正确(或)您想要分配的领土已被删除。"details"键提供了具有无效ID的领土JSON对象的路径。使用获取领土API获取可用领土及其各自的唯一ID列表。在请求输入中指定有效的领土ID。 - MANDATORY_NOT_FOUNDHTTP 400
缺少预期的参数
解决方案:您没有指定必须分配给哪个领域的记录的唯一ID。使用获取记录API来获取可用记录及其各自的唯一ID。在请求输入中指定有效的记录ID。 - MANDATORY_NOT_FOUNDHTTP 400
未找到必需的字段
解决方案:您没有在输入中指定领土ID(或)为"Territories"键传递了一个空的JSON数组(或)您没有在请求输入中指定"Territories"键。使用获取领土API来获取可用领土及其各自的唯一ID。在请求输入中指定有效的领土ID。 - DUPLICATE_DATAHTTP 400
给定的领域已经存在于该记录中
解决方案:你只能为一个记录分配一次领域。 - ALREADY_USEDHTTP 400
发现重复的领土ID
解决方案:在输入记录中每个领土ID只使用一次。 - INVALID_DATAHTTP 400
请求输入中一个或多个键具有无效的值。响应具有多个响应状态。
解决方案:参考上面的请求JSON键部分,并指定有效的请求输入。 - OAUTH_SCOPE_MISMATCHHTTP 401
无效的OAuth范围以访问此URL
解决方案:客户端没有ZohoCRM.modules.{module_name}.ALL/UPDATE范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。 - TERRITORY_NOT_ENABLEDHTTP 403
您正在尝试将领土分配给潜在客户模块中的记录(或)领土功能未启用。
解决方案:您不能直接使用此API将领土分配给潜在客户;联系支持团队提出同样的请求。联系您的管理员为您想要分配领土的模块启用领土功能。 - NO_PERMISSIONHTTP 403
拒绝创建记录的权限。
解决方案:您没有更新变量的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。