CLcloudbeds
Reservation

putReservation

Changed on

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

put/putReservation

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/putReservation
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:reservation

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

reservationIDstring

Reservation Unique Identifier, one reservation ID per call.

estimatedArrivalTimestring time nullable

Estimated Arrival Time, 24-hour format.

status'confirmed' | 'not_confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show' nullable

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

checkoutDatestring date nullable

Update the checkoutDate across the whole reservation

dateCreatedstring date-time nullable

Date reservation was made. Do not change if omitted.

allotmentBlockCodestring nullable

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.

eventCodestring nullable

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=).

sendStatusChangeEmailboolean nullable

Send email on reservation status change to property and guest.

canceledByGuestboolean nullable

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.

modifiedByGuestboolean nullable

Marks a reservation update as initiated by the guest. When enabled for the property, guest changes to dates, room type, rate plan and occupancy are rejected after the free-cancellation deadline. Send rooms.rateID for each room; otherwise that room is priced on its type's Base Rate.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs.

dataobject nullable

Returns the reservation data as defined by getReservation call.

Changes

  • 6f4f997d5f7aRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property