cancelBooking( )
Cancels a booking.
Description
The booking status changes to CANCELED
.
If the booking was for an appointment, the corresponding session is deleted from the business calendar.
If the booking was for a class or course, the participants are removed from the class session or the course. But the course or class session remains on the business calendar.
You can pass a participantNotification.message
to notify the customer of
the cancelation. You also need to pass participantNotification.notifyParticipants
as true
to actually send the message.
In case you want to cancel a booking on behalf of a customer, we recommend
to pass flowControlSettings.ignoreCancellationPolicy
as false
. This
ensures that the cancelation is validated against the service's cancelation
policy.
This function is not a universal function and runs only on the backend.
This function requires elevated permissions to run. This function is not universal and runs only on the backend.
Syntax
function cancelBooking(bookingId: string, options: CancelBookingOptions): Promise<CancelBookingResponse>
cancelBooking Parameters
NAME
TYPE
DESCRIPTION
ID of the booking to cancel.
An object representing the available options for canceling a booking.
Returns
Return Type:
NAME
TYPE
DESCRIPTION
Canceled booking.
Was this helpful?
cancelBooking example
1import { bookings } from 'wix-bookings.v2';23 async function cancelBooking(bookingId, options) {4 try {5 const result = await bookings.cancelBooking(bookingId, options);67 return result;8 } catch (error) {9 console.error(error);10 // Handle the error11 }12 }13