CLcloudbeds
Guest

putGuest

Changed on

Updates an existing guest with information provided. At least one information field is required for this call.

put/putGuest

Request

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

guestIDstring

Valid Guest ID

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

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'na' | 'driver_licence' | 'student_id' | 'passport' | 'dni' | 'nie' | 'social_security_card' | 'cpf' nullable

It is mandatory to send all document information<br /> na - non selection<br /> dni - Identity card<br /> nie - Residence permit<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

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.

guestCompanyNamestring nullable

Guest company name

guestCompanyTaxIdstring nullable

Guest company tax ID

guestTaxIdstring nullable

Guest tax ID unencrypted payment data through the API. Numeric values longer than 12 characters and considered valid by Luhn's algorithm will be rejected.

Response

200 Response

successboolean

Returns if the request could be completed

messagestring nullable

To be used in case any error occurs (if success = false), or in case any warning message is needed. If success = true, it usually does not exist.

Changes