删除回收站记录
目的
要从您的 Zoho CRM 账户的回收站中删除一条或多条记录。
端点
- DELETE /settings/recycle_bin/{record_ID}
- DELETE /settings/recycle_bin?ids={record_ID1,record_ID2,...}
- DELETE /settings/recycle_bin?filters={filter_value}
请求详情
请求 URL
通过 ID 删除特定记录:
{api-domain}/crm/{version}/settings/recycle_bin/{record_ID}
要删除一批记录:
{api-domain}/crm/{version}/settings/recycle_bin?ids={record_ID1, record_ID2, record_ID3,...}
根据 filters 参数删除记录:
{api-domain}/crm/{version}/settings/recycle_bin?filters={filter_value}
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.recycle_bin.DELETE
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/recycle_bin?ids=4876876000003274910,4876876000003278075,4876876000003280538"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"注意
- 当您从回收站删除一条记录时,其在回收站中的所有关联记录也会被删除。例如,当删除一条潜在客户记录时,与其关联的备注和 Attachments 也会从回收站中移除。在这种情况下,如果记录数量超过 1000 条(包括父记录),将安排一个删除任务。
参数
- ids字符串,可选
用于根据其唯一 ID 删除特定记录。您最多可以指定 100 个要删除的记录 ID。
可能的值: 有效的记录唯一 ID,以逗号分隔的格式。示例:4150868000001944196,487687600000327055 - filtersJSON 对象,可选
要删除符合已定义条件的记录,可使用逻辑运算符和比较运算符,按显示名称、模块、删除者和删除时间等字段进行筛选。
注意: 在进行 API 调用之前,请确保对 filters 参数值进行编码。
JSON 键位于 filters 参数中:
- group_operator 字符串,可选
定义如何组合在 group 数组中定义的多个条件。
可能的取值:AND - groupJSON 数组,必填
一个过滤条件数组,其中每个条件指定字段、比较运算符和值。
- 字段JSON 对象
表示用于筛选记录的字段。请参阅筛选 Attributes部分以了解可能的取值。
- 比较器字符串
表示比较运算符,例如 equal、not_equal、contains 等。请参阅筛选 Attributes部分,以了解每个字段的可能取值。
- 值字符串/JSON 对象
表示要与该字段比较的值。根据字段不同,它可以是字符串或 JSON 对象。有关更多详细信息,请参阅示例部分。
筛选器属性:
- 显示名称
记录的显示名称。可用于display_name的条件为equal, not_equal, contains, not_contains, starts_with,以及ends_with。
- 模块
模块的 API 名称。回收站中来自该模块的记录将被筛选以进行删除。可应用于 module 的 conditions 是 equal 和 not_equal
- 删除者
删除该记录的用户姓名。可用于 deleted_by 的 条件 包括 equal, not_equal, contains, not_contains, starts_with, 和 ends_with。
- 删除时间
记录被删除的日期和时间,采用ISO 8601 日期时间格式。可应用的条件适用于deleted_time,包括equal, not_equal, greater_than, 和 less_than。
注意
当您使用 filters 参数根据定义的条件删除记录时,该过程是异步的,并且会安排一个删除作业。
示例回应
Copied{
"recycle_bin": [
{
"code": "SUCCESS",
"details": {
"id": "4876876000003274910"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "4876876000003278075"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "4876876000003280538"
},
"message": "record deleted",
"status": "success"
}
]
}可能的错误
- INVALID_DATA HTTP 400
- 提供的 ID 似乎无效。
解决方案: 请指定有效的记录 ID。 - 不支持所给的组运算符。仅支持 'AND' 运算符
解决方案: 使用 AND 组运算符构造 filters 参数值。 - 提供的 API 名称似乎无效
解决方案: 请为 filters 参数中的字段指定有效的 API 名称。
- 提供的 ID 似乎无效。
- INVALID_REQUEST_METHOD HTTP 400
请求方法不正确。
解决方案:请使用 HTTP DELETE 方法发起此 API 调用。使用任何其他请求方法都会导致此错误。 - OAUTH_SCOPE_MISMATCH HTTP 401
您用于进行此 API 调用的访问令牌不具备所需的作用域。
解决方法:为此 API 生成包含所需作用域的新访问令牌。有关所需作用域的列表,请参阅本页开头的作用域部分。 - INVALID_URL_PATTERN HTTP 404
请求的 URL 不正确。
解决方法:指定有效的请求 URL。有关详细信息,请参阅本页开头的请求 URL部分。 - INTERNAL_ERROR HTTP 500
服务器发生了意外且未处理的异常。
解决方法:请联系 support@zohocrm.com 的支持团队。
使用 filters 参数的示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/recycle_bin?filters=%7B%22group_operator%22%3A%22AND%22%2C%22group%22%3A%5B%7B%22field%22%3A%7B%22api_name%22%3A%22display_name%22%7D%2C%22comparator%22%3A%22contains%22%2C%22value%22%3A%22Paul%22%7D%2C%7B%22field%22%3A%7B%22api_name%22%3A%22module%22%7D%2C%22comparator%22%3A%22equal%22%2C%22value%22%3A%22Leads%22%7D%5D%7D"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"示例回应
Copied{
"recycle_bin": [
{
"code": "SCHEDULED",
"details": {},
"message": "Bulk deletion of records based on filters has been scheduled",
"status": "success"
}
]
}