删除记录
目的
从模块中删除实体或记录。
端点
- DELETE /{module_api_name}?ids={record_id1,record_id2,..}
- DELETE /{module_api_name}/{record_id}
请求详情
Request URL
{api-domain}/crm/{version}/{module_api_name}?ids={record_id1,record_id2,..}
删除特定记录:
{api-domain}/crm/{version}/{module_api_name}/{record_id}
支持的模块
潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格书,报价,销售订单,采购订单,发票,自定义,预约,预约重新安排历史,服务和活动
头部
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.ALL
(or)
scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,自定义,预约,预约重新安排历史,服务和活动
可能的操作类型
ALL - 对记录的完全访问
DELETE - 在模块中DELETE记录
参数
- ids字符串,必填
指定您要删除的记录的唯一ID。
可能的值:用逗号分隔的实体ID。
例如:410405000002264040,410405000002264025。 - wf_trigger布尔值,可选
表示是否在删除记录时触发工作流规则。默认值为true。
可能的值 - true:触发关联的工作流;false:不触发关联的工作流。
注意
- 每次API调用最多可以删除100条记录。
- 默认情况下,与此API相关的所有工作流将被执行。
- 与此API相关的所有子表单将被删除。
样本请求
可能的错误
- INVALID_DATAHTTP 400
记录未删除
解决方案:您试图删除的记录已经被删除。请指定一个有效的记录ID。参考获取记录API以获取有效的记录ID。 - UNABLE_TO_PARSE_DATA_TYPEHTTP 400
请求体或参数的格式错误
解决方案:参数值的格式错误。请以正确的格式指定有效的记录ID。请参考上述端点部分。 - INVALID_MODULEHTTP 400
给出的模块名称似乎无效
解决方案:您指定的模块名称无效,或者没有标签权限,或者该模块可能已从可用模块中移除。请指定一个有效的模块API名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方案:当前API不支持诸如文档和项目等模块。(一旦这些模块得到支持,将不会显示此错误)。请指定一个有效的模块API名称。 - INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案:指定的请求URL不正确。请指定一个有效的请求URL。请参考上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.modules.{module_name}.DELETE。创建一个具有有效范围的新客户端。请参考上述范围部分。 - NO_PERMISSIONHTTP 403
拒绝删除的权限
解决方案:用户没有删除记录的权限。请联系您的系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限来删除记录
解决方案: 用户没有删除记录的权限。请联系您的系统管理员。 - REQUIRED_PARAM_MISSINGHTTP 400
缺少预期的参数
解决方案: 请求中缺少 'ids' 参数。请指定要删除的记录的有效ID。请参考 获取记录API以获取有效的记录ID。 - RECORD_LOCKEDHTTP 400
无法删除尚未获得批准的记录
解决方案:请等待Zia图像或合并重复过程完成后再试。 - RECORD_LOCKEDHTTP 400
您无法执行此操作,因为记录已被锁定。
解决方案: 请等待记录解锁。 - NOT_APPROVEDHTTP 400
不能删除尚未获得批准的记录
解决方案:- 情况1: 如果记录由于Zia图像验证而处于被拒绝状态,删除失败的图像,并将记录重新提交给Zia图像验证。
- 情况2: 如果记录在Zia记录审批中,系统将不允许您更新记录的图像,直到审查者批准或拒绝记录。