event:cancel

命名空间:microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。

此操作允许会议组织者发送取消消息并取消活动。

该操作将事件移动到“已删除邮件”文件夹。 组织者还可以通过提供事件 ID 来取消定期会议的发生。 调用此操作的与会者在 HTTP 400 错误请求) (收到错误,并显示以下错误消息:

“你的请求无法完成。 你需要是组织者才能取消会议。”

此操作与 “删除” 不同之处在于 ,“取消” 仅对组织者可用,并允许组织者向与会者发送有关取消的自定义消息。

此 API 可用于以下国家级云部署

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) Calendars.ReadWrite 不可用。
委派(个人 Microsoft 帐户) Calendars.ReadWrite 不可用。
应用程序 Calendars.ReadWrite 不可用。

HTTP 请求

POST /me/events/{id}/cancel
POST /users/{id | userPrincipalName}/events/{id}/cancel
POST /groups/{id}/events/{id}/cancel

POST /me/calendar/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendar/events/{id}/cancel
POST /groups/{id}/calendar/events/{id}/cancel

POST /me/calendars/{id}/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendars/{id}/events/{id}/cancel

POST /me/calendarGroups/{id}/calendars/{id}/events/{id}/cancel
POST /users/{id | userPrincipalName}/calendarGroups/{id}/calendars/{id}/events/{id}/cancel

请求标头

名称 类型 说明
Authorization string 持有者 {token}。 必填。 详细了解 身份验证和授权
Content-Type string 实体正文中的数据性质。 必填。

请求正文

在请求正文中,提供具有以下参数的 JSON 对象。

参数 类型 说明
注释 String 发送给所有与会者的关于取消的注释。 可选。

响应

如果成功,此方法返回 202 Accepted 响应代码。 它不会在响应正文中返回任何内容。

示例

下面是一个如何调用此 API 的示例。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/me/events/{id}/cancel
Content-type: application/json

{
  "Comment": "Cancelling for this week due to all hands"
}
响应

以下示例显示了相应的响应。

HTTP/1.1 202 Accepted