CLcloudbeds
Guest

postGuestsToRoom

Assigns guest(s) to a room in a reservation and adds these guests as additional guests.

post/postGuestsToRoom

Request

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

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

reservationIDstring

Reservation ID

roomIDinteger

Room ID already assigned to Reservation

guestIDsstring

Guest ID(s) to be assigned to room. If more than one, send as comma-separated, i.e. 37,345,89

removeGuestIDsstring nullable

If sent, will remove guest ID(s) before adding guests sent in guestIDs parameter. If more than one, send as comma-separated, i.e. 37,345,89. Main Guest is never removed.

removeGuestIDsFromRoomstring nullable

If sent, will remove guest ID(s) only from the specified Room ID(s). If more than one, send as comma-separated, i.e. 37,345,89. Incompatible with removeAll parameter.

removeAllboolean nullable

If set true, will remove all guests assigned to roomID before assigning guests sent in guestIDs parameter. Main Guest is never removed.

mainGuestIdstring nullable

Guest ID to promote as main guest of the booking room. MUST be present in guestIDs. When omitted, the room's main guest is left unchanged.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.