批量删除记录
目的
要批量删除模块的记录。您可以在自定义视图中删除最多 50,000 条记录,或者在 API 调用中使用记录 ID 删除最多 500 条记录。
端点
- POST /{module_api_name}/actions/mass_delete
请求详情
请求 URL
{api-domain}/crm/{version}/{module_API_name}/actions/mass_delete
支持的模块
潜在客户,Account,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,服务,预约和自定义模块
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.mass_delete.DELETE
(或)
ZohoCRM.mass_delete.{module_name}.DELETE
可能的模块名称
线索、账户、联系人、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、服务、预约和自定义
注意
- 您可以在一次 API 调用中从自定义视图中删除最多 50,000 条记录,并使用其记录 ID 删除 500 条记录。
- 当您指定记录 ID 时,如果其中一个或多个 ID 无效,则只有那些记录不会被删除。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads/actions/mass_delete"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@input.json"
-X POST请求 JSON 键
- cvid字符串,当不包含“ids”时为必填项
要删除其记录的自定义视图的唯一ID。使用自定义视图元数据API获取自定义视图的ID。
注意
cvid键在以下版本中支持通过API进行批量删除:
- 企业版
- 终极版
- CRM Plus
- Zoho One 企业版
- idsJSON 对象,当不包含 "cvid" 时为必填项
要删除的记录的唯一 ID。使用 获取记录 API 来获取记录 ID。
- territoryJSON 对象,可选
要删除其记录的领土的唯一 ID。使用 获取领土 API 获取领土的 ID。
include_child布尔值,可选表示是否要删除子领土中的记录。
示例输入包含记录ID
Copied{
"ids":["3652397000006064023","3652397000003852074"]
}示例请求输入中的记录ID
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "3652397000006064023"
},
"message": "record is deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "3652397000003852074"
},
"message": "record is deleted",
"status": "success"
}
]
}示例输入包含CVID和领土
Copied{
"cvid": "3652397000000538003",
"territory": {
"id": "3652397000007622003",
"include_child": true
}
}响应 JSON 键
- code
表示API是否成功。
- details
- 当您提供CVID时,响应包含批量Delete作业的ID。使用此ID在批量DeleteStatusAPI中。
- 当您在请求正文中提供记录ID时,此键包含被Delete的记录ID。
可能的错误
- INVALID_DATAHTTP 400
记录ID无效。
解决方法:提供有效的ID。使用获取记录API来获取记录ID。 - ALREADY_SCHEDULEDHTTP 400
您正在尝试进行批量删除,但已有一个批量删除任务正在运行。
解决方案:您一次只能安排一个批量删除任务。请等待已安排的任务完成后再安排另一个任务。 - MANDATORY_NOT_FOUNDHTTP 400
您未指定 CVID 或记录 ID。
解决方法:您必须在输入主体中指定 CVID 或记录 ID。 - AUTHORIZATION_FAILEDHTTP 400
您没有足够的权限批量删除记录。
解决方法:请联系您的系统管理员。 - INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。 - NOT_APPROVEDHTTP 400
您尝试删除的记录未获批准。
解决方案:您只能删除已批准的记录。 - NOT_SUPPORTEDHTTP 400
该模块不支持通过API进行批量删除。
解决方法:请联系您的管理员。 - AUTHENTICATION_FAILUREHTTP 401
您未使用有效的访问令牌对API调用进行身份验证。
解决方法:在请求头中包含有效的访问令牌以对API调用进行身份验证。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌没有所需的范围。
解决方法:生成一个具有范围 ZohoCRM.modules.{module_name}.{operation_type} 的新访问令牌。有关详细信息,请参阅可能的模块名称和可能的操作类型部分。 - NO_PERMISSIONHTTP 403
您没有删除记录或批量删除的权限。
解决方案:请联系您的管理员以获得从模块中删除或批量删除记录的权限。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定一个有效的请求URL。请参阅请求URL部分以获取正确的URL。 - INTERNAL_ERRORHTTP 500
服务器中出现意外且未处理的异常。
解决方法:联系支持团队,邮箱:support@zohocrm.com。
输入包含CVID和领土的示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"job_id": "3652397000009565021"
},
"message": "mass delete scheduled successfully",
"status": "success"
}
]
}