Cancel a booking

Undoes a booking this key created — the one thing the External API has
never been able to do. A separate scope from bookings:write on
purpose: a key issued to sell rooms should not also be able to
un-sell the hotel's. A leaked write-only key can cost the merchant
inventory; one that could also cancel could empty the property's
forward book.

Idempotent by state, not by Idempotency-Key. Cancelling an
already-cancelled booking answers 200 with the same body rather
than an error — a retry after a lost response is the normal case, not
a mistake to refuse.

Only a stay that has not started — pending or confirmed — can be
cancelled here.
A merchant can reverse a stay that is already
checked_in or checked_out by hand in the PMS, because a human is
there to weigh the folio consequences. This endpoint deliberately
cannot: cancelling a checked_in booking would mark an occupied room
available and manufacture an overbooking, and reversing a completed
stay is a merchant-only correction. Neither is something a leaked key
should be able to trigger.

A booking outside this property answers 404, identically to one
that does not exist.

Scope: bookings:cancel · Property-bound

See Holds.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Headers
uuid

Which property this call acts on.

Required when your key covers more than one property; omitting it
is 422 PROPERTY_NOT_IDENTIFIED.

Omit it when your key covers exactly one — it is inferred, and
sending a different id is 404.

When to send it and what each scope unlocks: Alcances y el header X-Property.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json