cancelReservation( )


Developer Preview

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

Cancels a reservation.

Sets the reservation status to CANCELED.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reservations (Medium)
Manage Reservations (Full)
Manage Reservations (Basic)
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
reservationIdstringRequired

Reservation ID.


revisionstringRequired

Revision number.

Include the existing revision to prevent conflicting updates to reservations.


optionsCancelReservationOptions

Options for canceling the reservation.

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