declineBooking( )

Declines a pending booking request.

The declineBooking() function returns a Promise that resolves when the specified booking is declined.

A service can be set to "Automatically accept all bookings when staff are available" or "Manually approve or decline booking requests" in the Online Booking Preferences page under "Additional Settings". When set to manual, the business must confirm or decline each request.

When a booking is declined, the following events occur:

  • The booking status changes from PENDING_APPROVAL to DECLINED.
  • The participant status on the session changes to DECLINED.
  • The corresponding session or participant is deleted from the calendar.
  • An email notification is sent to the participant according to the participantNotification properties.

Note: Only users with Bookings Admin permissions can decline a booking. You can override the permissions by setting the suppressAuth options to true.

Method Declaration
Copy
Method Parameters
bookingIdstringRequired

ID of the booking to be declined.

optionsDeclineBookingOptionsRequired

An object representing the available options for declining a booking.

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