Cancel Booking

Updates the booking status to CANCELED.

Appointments

For appointments, the corresponding event is removed from the Bookings calendar.

Class and course bookings

For class or course bookings, the relevant participants are removed from the class session or the course. However, the class session or course remain on the business calendar.

Notify customers

You can specify a participantNotification.message for the customer. To send the message, you must also specify participantNotification.notifyParticipants as true.

Admin overwrites

There are small but important differences when you specify special flowControlSettings:

• {"ignoreCancellationPolicy": true}: The call succeeds even if the service's cancellationPolicy doesn't allow it.
• {"withRefund": true}: The customer is refunded even if the service's refundPolicy doesn't allow it.
• {"waiveCancellationFee": true}: The customer doesn't have to pay the cancellation fee, even if the service's cancellationPolicy requires it.

When using special flowControlSettings, ensure you have sufficient permissions. If you encounter failed calls due to insufficient permissions, consider the following options:

• App developers can use a higher permission, such as MANAGE BOOKINGS - ALL PERMISSIONS.
• Site developers can utilize elevation.

Granting additional permissions and using elevation permits method calls that would typically fail due to authorization checks. Therefore, you should use them intentionally and securely.