bookingAppointment: cancel

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Cancel the specified bookingAppointment in the specified bookingBusiness, and send a message to the involved customer and staff members.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) BookingsAppointment.ReadWrite.All Bookings.Manage.All, Bookings.ReadWrite.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application Bookings.ReadWrite.All Bookings.Manage.All

HTTP request

POST /solutions/bookingBusinesses/{id}/appointments/{id}/cancel

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

In the request body, provide a JSON object with the following parameters.

Parameter Type Description
cancellationMessage String A message to acknowledge with the customer that the appointment has been canceled.

Response

If successful, this method returns a 204 No Content response code. It doesn't return anything in the response body.

If you attempt to cancel an appointment that doesn't exist, this method returns HTTP 404 Not Found.

Example

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/solutions/bookingBusinesses/contosolunchdelivery@contoso.com/appointments/AAMkADKoAAA=/cancel
Content-type: application/json

{
  "cancellationMessage": "Your appointment has been successfully cancelled. Please call us again."
}

Response

The following example shows the response.

HTTP/1.1 204 No content