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 {code}
Request body
In the request body, provide a JSON object with the following parameter.
Parameter
Type
Description
cancellationMessage
String
A message to acknowledge with the customer that the appointment has been cancelled.
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.
POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.com/appointments/AAMkADKoAAA=/cancel
Content-type: application/json
{
"cancellationMessage": "Your appointment has been successfully cancelled. Please call us again."
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Solutions.BookingBusinesses.Item.Appointments.Item.Cancel;
var requestBody = new CancelPostRequestBody
{
CancellationMessage = "Your appointment has been successfully cancelled. Please call us again.",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.Solutions.BookingBusinesses["{bookingBusiness-id}"].Appointments["{bookingAppointment-id}"].Cancel.PostAsync(requestBody);
// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc solutions booking-businesses appointments cancel post --booking-business-id {bookingBusiness-id} --booking-appointment-id {bookingAppointment-id} --body '{\
"cancellationMessage": "Your appointment has been successfully cancelled. Please call us again."\
}\
'
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.solutions.bookingbusinesses.item.appointments.item.cancel.CancelPostRequestBody cancelPostRequestBody = new com.microsoft.graph.solutions.bookingbusinesses.item.appointments.item.cancel.CancelPostRequestBody();
cancelPostRequestBody.setCancellationMessage("Your appointment has been successfully cancelled. Please call us again.");
graphClient.solutions().bookingBusinesses().byBookingBusinessId("{bookingBusiness-id}").appointments().byBookingAppointmentId("{bookingAppointment-id}").cancel().post(cancelPostRequestBody);
<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\CancelPostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new CancelPostRequestBody();
$requestBody->setCancellationMessage('Your appointment has been successfully cancelled. Please call us again.');
$graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->appointments()->byBookingAppointmentId('bookingAppointment-id')->cancel()->post($requestBody)->wait();
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.