confirmOrDeclineBooking( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Use confirmOrDeclineBooking() to determine if the booking is valid, payment is received, and the booking can be processed. Call confirmOrDeclineBooking() after checkout or after calling createBooking() to verify the booking.

  • If a session is valid and payment is received, the booking is visible on the calendar.
  • If a session is double booked, confirmOrDeclineBooking() can catch this and decline the duplicate booking, the booking is not visible on the calendar.
Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings
Manage Bookings - all permissions
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
bookingIdstringRequired

ID of the booking to confirm or decline.

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