declineBooking( )

Developer Preview

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

Declines a PENDING booking request and changes the booking status to DECLINED.

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

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

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

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 decline.

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.

optionsDeclineBookingOptions

An object representing the available options for declining a booking.

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