删除预约
目的
若要删除您组织中的现有预约。
端点
- DELETE /Appointments__s?ids={appointment_ID1,appointment_ID2,...appointment_ID100}
- DELETE /Appointments__s/{appointment_ID}
请求详情
请求 URL
{api-domain}/crm/{version}/Appointments__s?ids={appointment_id1,appointment_id2,...appointment_id100}
要删除特定的预约:
{api-domain}/crm/{version}/Appointments__s/{appointment_id}
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.appointments.{operation_type}
可能的操作类型
全部 - 对预约数据的完全访问权限
Delete - Delete 预约数据
参数
- ids字符串,必填(仅在删除多个预约时)
指定需要删除的预约的唯一 ID。
您可以从 GET Appointments API 获取预约 ID。
注意
- 每次 API 调用最多可删除 100 个预约。
- 此 API 不会删除在预约完成时创建的交易。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Appointments__s?ids=5545974000002140053,5545974000002140009"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"可能的错误
- INVALID_DATAHTTP 400
您在请求 URL 中提供了无效的预约 ID,该 ID 要么不正确,要么已被删除。
解决方案:调用 GET Appointments API 并提供一个有效的预约 ID。 - INVALID_REQUEST_METHODHTTP 400
您提供了无效的 HTTP 请求方法类型。
解决方案:在请求 URL 中仅使用 DELETE 方法来访问此 API。 - REQUIRED_PARAM_MISSINGHTTP 400
您未指定要删除的预约 ID。
解决方案:在请求 URL 中指定预约 ID。 - INVALID_TOKENHTTP 401
您使用了无效的 OAuth 令牌。
解决方案:您使用的访问令牌已过期。请刷新您的令牌并重试。 - OAUTH_SCOPE_MISMATCHHTTP 401
您使用了错误的 OAuth 作用域创建了授权令牌。
解决方案:使用 ZohoCRM.modules.appointments.DELETE 或 ZohoCRM.modules.appointments.ALL 作用域来创建新的有效授权令牌。 - NO_PERMISSIONHTTP 403
您没有权限删除任何预约。
解决方案: 请联系您的系统管理员。 - 无效_URL_模式HTTP 404
请检查您是否正在尝试访问正确的URL。
解决方案:您提供了无效的请求URL。请查看上面的端点部分,并提供一个有效的URL。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中发生了意外且未处理的异常。请联系我们的支持团队。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "5545974000002140053"
},
"message": "record deleted",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"id": "5545974000002140009"
},
"message": "record deleted",
"status": "success"
}
]
}