批量更改所有者
目的
在Zoho CRM的模块中批量更新特定自定义视图或区域中的记录所有权。
端点
- POST /{module_API_name}/actions/mass_change_owner
请求详情
请求URL
{api-domain}/crm/{version}/{module_API_name}/actions/mass_change_owner
支持的模块
潜在客户,Account,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,Vendors,价格表,报价,Sales Orders,采购Orders,Invoices,以及自定义
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.change_owner.CREATE
注意
- 您无法更改相关记录的所有者。
- 您可以在自定义视图中更改最多 50,000 条记录的所有者。
- 此 API 会安排一个作业并为您提供一个作业 ID 以获取 API 的状态。
- 作业状态可检索长达 60 天。
- 批量更改所有者 API 在 企业版 和 终极版 中均受支持。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Deals/actions/mass_change_owner"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST请求 JSON
- cvid string, mandatory
要更改其记录所有者的自定义视图的唯一ID。使用自定义视图元数据API获取自定义视图的ID。请注意,当您想要更改自定义视图中记录的所有者时,此API会安排一个任务并返回一个任务ID。使用此ID与批量更改所有者StatusAPI一起使用,以跟踪任务Status。
- owner JSON object,mandatory
要分配记录的新所有者的唯一 ID。使用 获取 Users API 来获取用户的 ID。
- territory JSON 对象,当您想要更改领地中记录的所有者时是必需的
要重新分配给新所有者的领地的唯一ID。使用 获取领地 API 来获取领地的ID。
- criteria JSON object,optional
应用特定条件以筛选所有权将被更改的记录。
- field JSON object,optional
条件适用的字段。提供其API 名称或唯一ID。使用字段元数据 API检索字段详细信息。
- comparator字符串,必填(使用条件时必填)
指定比较运算符。
- value字符串,必填(使用条件时必填)
字段必须匹配的特定值,以应用条件。
示例输入
Copied{
"cvid" : "2423488000000091545",
"owner":{
"id" : "2423488000000483001"
},
"territory": {
"id": "2423488000000780003",
"include_child": true
},
"criteria" : {
"field" : {
"api_name" : "Stage",
"id" : "2423488000000000525"
},
"comparator" : "equal",
"value": "Qualification"
}
}在示例请求中,条件筛选交易模块中阶段字段设置为资格审查的记录。这些在指定区域和自定义视图中的筛选记录将重新分配给新所有者。
响应 JSON
- code string
表示请求的结果。
- details JSON object
包含计划任务的唯一标识符。此 ID 可用于 批量更改所有者 Status API 以监控任务的进度和结果。
- message string
确认请求Status的简短消息。
- Status string
指示请求的Status。
可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP PUT 方法进行此 API 调用。任何其他请求方法都会导致此错误。 - INVALID_DATAHTTP 400
原因:
- CVID 无效。
- 领土 ID 无效。
- 用户 ID 无效。
- 您尝试分配记录的用户已从您的组织中删除。
- 您尝试分配记录的用户处于非活动状态。
解决方案:
- 提供有效的用户、CVID 和领土 ID。
- MANDATORY_NOT_FOUNDHTTP 400
您未指定 CVID、所有者 ID 或两者。
解决方案:输入中必须包含 CVID 和所有者 ID。 - RECORD_LIMIT_EXCEEDEDHTTP 400
自定义视图中有超过 50,000 条记录。
解决方案:通过此 API,您只能更改自定义视图中最多 50,000 条记录的所有者。 - NO_PERMISSIONHTTP 403
原因:
- 您没有该模块的权限。
- 您没有更改所有者的权限。
- 您没有查看该自定义视图中记录的权限。
解决方法: 联系您的系统管理员以获取足够的权限。
- INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:请联系支持团队,邮箱地址为 support@zohocrm.com。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"job_id": "3652397000009026002"
},
"message": "change owner is successfully scheduled",
"status": "success"
}
]
}