CLcloudbeds
Guest

postGuest

Changed on

Adds a guest to reservation as an additional guest.

post/postGuest

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postGuest
  • 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

guestFirstNamestring
guestLastNamestring
guestGender'M' | 'F' | 'N/A' nullable
guestEmailstring
guestPhonestring nullable
guestCellPhonestring nullable
guestAddress1string nullable
guestAddress2string nullable
guestCitystring nullable
guestCountrystring

ISO-Code for Country (2 characters)

guestNationalitystring nullable

Guest nationality (citizenship). ISO-Code for Country (2 characters)

guestStatestring nullable
guestZipstring nullable
guestBirthDatestring date nullable
guestDocumentType'cpf' | 'dni' | 'driver_license' | 'na' | 'nie' | 'passport' | 'social_security_card' | 'student_id' nullable

Document Type<br /> dni - Identity card<br /> nie - Residence permit<br /> na - non selection<br /> cpf - Brazilian Tax ID<br />

guestDocumentNumberstring nullable

(mandatory when guestDocumentType is sent)

guestDocumentIssueDatestring date nullable

(mandatory when guestDocumentType is sent and is not DNI or CPF)

guestDocumentIssuingCountrystring nullable

Valid ISO-Code for Country (2 characters) (mandatory when guestDocumentType is sent)

guestDocumentExpirationDatestring date nullable

(mandatory when guestDocumentType is sent and is not DNI, NIE, or CPF)

guestRequirementsobject[] nullable

Object with guest requirements information.

guestNotestring nullable

Note to be added to the Guest

reservationNotestring nullable

Note to be added only to the Reservation.

guestCompanyNamestring nullable

Guest company name

guestCompanyTaxIdstring nullable

Guest company tax ID

guestTaxIdstring nullable

Guest tax ID

Response

200 Response

successboolean

Returns if the request could be completed

guestIDstring nullable

Returns the Guest ID if the request could be completed successfully

messagestring nullable

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

Changes