取消会议
目的
取消会议并向参与者发送有关会议取消的电子邮件。
端点
- POST /Events/{event_id}/actions/cancel
请求详情
请求URL
{api-domain}/crm/{version}/Events/{event_id}/actions/cancel
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.Modules.ALL
(或)
ZohoCRM.Modules.Events.{operation_type}
可能的操作类型
ALL - 完全访问会议模块
UPDATE- Update 会议
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Events/4876876000001563018/actions/cancel"
-X POST
-d input_data.json
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"注意
- 只有在已经邀请与会者的情况下,会议才能被取消。
- 会议在预定结束时间之后不能被取消。
- 要检查会议的取消状态,请参考 GET Meetings API 响应中的 $event_cancelled 键。更多详情,请参阅 获取记录 API 文档。
输入 JSON
- send_cancelling_mail Boolean, mandatory
说明是否向参与者发送会议取消通知邮件。
示例输入
Copied{
"data": [
{
"send_cancelling_mail" : false
}
]
}可能的错误
- INVALID_REQUEST_METHODHTTP 400
请求方法不正确。
解决方法:使用 HTTP POST 方法来进行此 API 调用。任何其他请求方法都会导致此错误。 - INVALID_DATAHTTP 400
提供的ID似乎无效
解决方法:请指定一个有效的会议ID。 - MANDATORY_NOT_FOUNDHTTP 400
未找到必填字段
解决方案:您未在输入主体中指定send_cancelling_mail键。请指定必填键。 - NOT_ALLOWEDHTTP 400
该事件已被取消
解决方案:您正在尝试取消一个已经取消的会议。请指定一个有效的会议ID。 - NOT_ALLOWEDHTTP 400
您不能在没有邀请参与者的情况下取消事件
解决方案:没有参与者的会议不能取消。邀请参与者参加会议并取消会议,或者指定一个有参与者的会议ID。 - NOT_ALLOWEDHTTP 400
会议结束时间后无法取消会议
解决方案:会议结束时间后无法取消会议。请指定有效的会议ID。 - CANNOT_PERFORM_ACTIONHTTP 400
没有权限对该记录执行操作
解决方法:用户没有权限访问该记录。请联系系统管理员。 - NO_PERMISSIONHTTP 400
权限被拒绝
解决方案: 用户没有权限取消会议。请联系系统管理员。 - DAILY_LIMIT_EXCEEDEDHTTP 400
已达到每日限制
解决方案:用户已达到每日邮件发送限制。无法再发送更多邮件。您可以选择不发送取消邮件,或在第二天取消会议。 - OAUTH_SCOPE_MISMATCHHTTP 401
您用于进行此 API 调用的访问令牌没有所需的范围。
解决方法:生成一个具有此 API 所需范围的新访问令牌。请参阅本页开头的范围部分以获取所需范围的列表。 - INVALID_URL_PATTERNHTTP 404
请求的URL不正确。
解决方法:请指定一个有效的请求URL。有关详细信息,请参阅本页开头的请求URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方法:服务器中出现意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"id": "4876876000001563018"
},
"message": "The event is successfully cancelled",
"status": "success"
}
]
}