Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Reservations Open Api [Beta]

Update reservation status

Update the status of a reservation to one of the supported statuses

put/reservations-v3/{reservationId}/status

Path parameters

reservationIdstring required
Example:5f92cbf10cf217478ba93561

The Guesty reservation ID

Request body

status'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired' required

Status of the reservation

canceledBy'OWNER' | 'GUEST' | 'TEAM_MEMBER' | 'HOST'

The person who cancelled reservation, if not defined will be TEAM MEMBER by default

cancellationReasonstring

The reason for cancelling a reservation

cancellationNotestring

The note for cancelling a reservation

reservedUntil-1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72

Duration until the reserved status expires. Only applicable when status is "reserved". Defaults to indefinitely (-1) if not provided.

Example request

{
  "status": "confirmed",
  "canceledBy": "GUEST",
  "cancellationReason": "OTA Policy",
  "cancellationNote": "Personal changes",
  "reservedUntil": 24
}

Response

Reservation Status Updated

reservationIdstring required
statusstring required
reservedUntil-1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72

Duration until the reserved status expires. Only present when status is "reserved".