cancelBooking( )

Cancels an existing booking.

The cancelBooking() function returns a Promise that resolves when the specified booking is canceled.

Canceling a booking causes the following changes:

  • The booking status changes to CANCELED.
  • The participant is removed from the session.
  • If the booking creates a session, the session that was created is deleted from the calendar.
  • The participant is notified, according to the participantNotification properties.

When cancelBooking() is invoked, the cancellation is validated against the service's bookings policy. If cancelBooking() is invoked by a Bookings Admin, the service's bookings policy can be ignored by setting ignoreCancellationPolicy to true.

Note: Only users with Bookings Admin permissions can cancel other customers' bookings. You can override the permissions by setting the suppressAuth option to true.

Method Declaration
Copy
Method Parameters
bookingIdstringRequired

ID of the booking to be canceled.

optionsCancelBookingOptionsRequired

An object representing the available options for canceling a booking.

Returns
Return Type:Promise<CancelBookingResult>
Was this helpful?
Yes
No