Cloudbeds · JSON Structure

Cloudbeds Guest Structure

A guest profile in Cloudbeds, used to associate one or more reservations with an identifiable person.

Type: Properties: 0
HospitalityHotelsPMSProperty ManagementChannel ManagerBooking EnginePayments

Guest is a JSON Structure definition published by Cloudbeds.

Meta-schema:

JSON Structure

Raw ↑
{
  "name": "Guest",
  "description": "A guest profile in Cloudbeds, used to associate one or more reservations with an identifiable person.",
  "fields": [
    { "name": "guestID", "type": "string", "required": true, "description": "Cloudbeds guest identifier" },
    { "name": "propertyID", "type": "string", "required": false, "description": "Cloudbeds property the guest belongs to" },
    { "name": "firstName", "type": "string", "required": false, "description": "Given name" },
    { "name": "lastName", "type": "string", "required": false, "description": "Family name" },
    { "name": "email", "type": "string", "required": false, "description": "Email address" },
    { "name": "phone", "type": "string", "required": false, "description": "Phone number" },
    { "name": "country", "type": "string", "required": false, "description": "ISO 3166-1 alpha-2 country code" },
    { "name": "documentType", "type": "string", "required": false, "description": "Identification document type (passport, drivers_license, national_id)" },
    { "name": "documentNumber", "type": "string", "required": false, "description": "Identification document number" },
    { "name": "address", "type": "string", "required": false, "description": "Street address" },
    { "name": "city", "type": "string", "required": false, "description": "City" },
    { "name": "stateOrProvince", "type": "string", "required": false, "description": "State or province" },
    { "name": "postalCode", "type": "string", "required": false, "description": "Postal code" },
    { "name": "dateOfBirth", "type": "date", "required": false, "description": "Date of birth" },
    { "name": "language", "type": "string", "required": false, "description": "Preferred language (ISO 639-1)" },
    { "name": "marketingOptIn", "type": "boolean", "required": false, "description": "Marketing communications opt-in" },
    { "name": "notes", "type": "string", "required": false, "description": "Free-form notes" }
  ]
}