confirmBooking( )


Developer Preview

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

Confirms a booking request and changes the booking status to CONFIRMED.

Calling this method doesn't check whether a slot or schedule is still available at this time.

You can only confirm bookings for services that require the owner's manual approval for bookings and that have a status of PENDING.

For appointment services the slot may become unavailable, depending on the service's policy.bookingApprovalPolicy.requestsAffectsAvailability.

Calling this method also changes the session's participants.approvalStatus to APPROVED.

You can pass a participantNotification.message to notify the customer of the confirmation. You also need to pass participantNotification.notifyParticipants as true to actually send the message.

Bookings are automatically confirmed when the service is configured to automatically confirm bookings and the eCommerce order has been approved. The slot's or schedule's availability is checked just before confirming the booking as part of the automatic flow.

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.


revisionstringRequired

Revision number, which increments by 1 each time the booking is updated. To prevent conflicting changes, the current revision must be passed when managing the booking.


optionsConfirmBookingOptions

An object representing the available options for canceling a booking.

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