Bookings
Cancel Booking
Request an idempotent cancellation for a confirmed or on-hold booking.
POST
Use this endpoint to cancel a
CONFIRMED or ON_HOLD booking. Cancellation is
idempotent: a repeat request for an already cancelled or cancelling booking
returns its current state rather than creating another cancellation.
Request Example
Handle Cancellation State
Keep the returned
booking_id and request ID in your support record. If the
request returns CANCELLATION_PENDING, do not assume the booking is cancelled
until status polling reports CANCELLED or another final state.
The OpenAPI section below documents the required booking ID, success response,
and error response.Authorizations
Environment-specific API key created in the Unifystays portal
Headers
Path Parameters
Example:
"ubk_eGQ0dW9uV1Vi"