Skip to the page

Praecise Platform

Rivier/ Reference/ bookings

Cancel a reservation

post/lodging/reservations/{id}/cancel

Cancel a reservation. States what the cancellation policy makes of it without moving money; a dry run changes nothing.

Before you call

Credential: Authorization: Bearer $KEY
Scope: bookings:write
Mcp: rivier_lodging_cancel
Graphql: Mutation.cancelReservation
Sdk: bookings.reservation.cancel
Cli: bookings reservation cancel
Events: bookings.reservation.cancelled

Parameters

idstring (uuid)required
In the path
dryRunstring
In the query

Request bodyapplication/json, required

reasonstring
Default: . At most 300 characters.

Responses

200application/json
Success
400application/json
The request was malformed
- errorstringrequired
- messagestring
401application/json
No valid credential
- errorstringrequired
- messagestring
403application/json
The credential lacks the scope, origin or address
- errorstringrequired
- messagestring
429application/json
Over the key's rate limit; see Retry-After
- errorstringrequired
- messagestring

Example request

curl -X POST 'https://api.rivier.ai/lodging/reservations/{id}/cancel' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "reason": ""
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown