Vacatia API Catalog
/
Berkley API
/
Guests

Berkley API (1.0.0-BETA2)

Download OpenAPI description
berkley.json
berkley.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/berkley/
The staging API server
https://porter-staging.vacatia.com/api/
The PRODUCTION API server
https://porter.vacatia.com/api/

Owners

Operations

Properties

Operations

Contracts

Operations

Reservations

Operations

Guests

Operations

Adds a guest to reservation as an additional guest.

Request

Path
propertyIdstringrequired
Example: MT-MLR
reservationIdstringrequired
Example: 0123456789
Bodyapplication/jsonrequired

The new guest

vacatiaOwnerIdstring

The Vacatia guest ID

Example: "V-0000-0000"
firstNamestringrequired

The guest's first name

Example: "Kathryn"
lastNamestringrequired

The guest's last name

Example: "Janeway"
emailAddressstring(email)

The guest's email address

mailingAddressobject(Address)

The guest's mailing address

homePhonestring

The guest's home phone number

mobilePhonestring

The guest's mobile phone number

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/reservations/0123456789/guests \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "vacatiaOwnerId": "V-0000-0000",
    "firstName": "Kathryn",
    "lastName": "Janeway",
    "emailAddress": "user@example.com",
    "mailingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "homePhone": "string",
    "mobilePhone": "string"
  }'

Responses

Guest resource created

Bodyapplication/json
idstringread-only

The Cloudbeds guest ID

Response
application/json
{
  "id": "string"
}

Fetch a guest

Request

Path
propertyIdstringrequired
Example: MT-MLR
guestIdstringrequired
Example: 0123456789
curl -i -X GET \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/guests/0123456789 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The requested guest

Bodyapplication/json
dataobject(Guest)
Response
application/json
{
  "data": {
    "id": "string",
    "vacatiaOwnerId": "V-0000-0000",
    "firstName": "James",
    "lastName": "Kirk",
    "emailAddress": "user@example.com",
    "mailingAddress": { … },
    "homePhone": "string",
    "mobilePhone": "string"
  }
}

Update a guest

Request

Path
propertyIdstringrequired
Example: MT-MLR
guestIdstringrequired
Example: 0123456789
Bodyapplication/jsonrequired

The guest changes

firstNamestring

The guest's first name

Example: "James"
lastNamestring

The guest's last name

Example: "Kirk"
emailAddressstring(email)

The guest's email address

mailingAddressobject(Address)

The guest's mailing address

homePhonestring

The guest's home phone number

mobilePhonestring

The guest's mobile phone number

curl -i -X PATCH \
  https://tbg-api-docs.vacatia.com/_mock/berkley/properties/MT-MLR/guests/0123456789 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "James",
    "lastName": "Kirk",
    "emailAddress": "user@example.com",
    "mailingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "homePhone": "string",
    "mobilePhone": "string"
  }'

Responses

The updated guest

Bodyapplication/json
dataobject(PostPatchGuestResponse)
Response
application/json
{
  "data": {
    "id": "string"
  }
}