putReservation

put

https://api.cloudbeds.com/api/v1.3/putReservation

Updates a reservation, such as custom fields, estimated arrival time, room configuration and reservation status.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

propertyID

string | null

Property ID

reservationID

string

Reservation Unique Identifier, one reservation ID per call.

estimatedArrivalTime

string | null

Estimated Arrival Time, 24-hour format.

status

string | null

enum

Reservation status
'confirmed' - Reservation is confirmed
'not_confirmed' - Reservation not passed confirmation
'canceled' - Reservation is canceled
'checked_in' - Guest is in hotel
'checked_out' - Guest already left hotel
'no_show' - Guest didn't showed up on check-in date

Allowed:

checkoutDate

date | null

Update the checkoutDate across the whole reservation

customFields

array of objects | null

Array with custom fields information

customFields

rooms

array of objects | null

Array with rooms information to change accommodations assigned to the reservation

rooms

dateCreated

date-time | null

Date reservation was made. Do not change if omitted.

allotmentBlockCode

string | null

Allotment block code to link the reservation to. If provided along with eventCode, the allotment block must belong to the event. To unlink, send the parameter with an empty value (allotmentBlockCode=); a form-urlencoded body cannot carry a real null, so sending the literal text "null" is treated as an ordinary block code rather than as an unlink. One unlink call clears both the allotment block and the event. Moving a reservation to a different block is unlink-then-link: sending a new code while the reservation is still linked is rejected.

eventCode

string | null

Event (group profile) code to link the reservation to. When sent without allotmentBlockCode, links to the group profile only. Unlinks the same way as allotmentBlockCode: send the parameter with an empty value (eventCode=).

sendStatusChangeEmail

boolean | null

Defaults to false

Send email on reservation status change to property and guest.

canceledByGuest

boolean | null

Defaults to false

Marks the cancellation as initiated by the guest (self-service portal, CFAR, or a guest request relayed by the integration). Only valid together with status='canceled' — sending it with any other status returns success=false. The reservation's main guest is recorded as the cancellation actor; the caller cannot supply actor identity.

Response

200200 Response