Vacatia API Catalog
/
Berkley API
/
Owners

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

Create an owner

Request

Bodyapplication/json
ownerTypestring
Default "individual"
Enum"individual""individual_legal_representative""corp_llc""trust""entity_legal_representative"
socialSecurityNumberstring

The owner's social security number (SSN)

Example: "123-45-6789"
salutationstring
firstNamestring
middleNamestring
lastNamestringrequired
suffixstring
emailAddressstring(email)
homePhoneNumberstring
mobilePhoneNumberstring
workPhoneNumberstring
mailingAddressobject(Address)

The guest's mailing address

billingAddressobject(Address)

The guest's billing address

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/berkley/owners \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ownerType": "individual",
    "socialSecurityNumber": "123-45-6789",
    "salutation": "Mr.",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "suffix": "Jr",
    "emailAddress": "user@example.com",
    "homePhoneNumber": "string",
    "mobilePhoneNumber": "string",
    "workPhoneNumber": "string",
    "mailingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "billingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    }
  }'

Responses

The created owner id

Bodyapplication/json
dataobject(OwnerResponse)
Response
application/json
{
  "data": {
    "id": "V-0000-0000"
  }
}

Update an owner

Request

Path
ownerIdstringrequired
Example: V-0000-0000
Bodyapplication/json
salutationstring
emailAddressstring(email)
homePhoneNumberstring
mobilePhoneNumberstring
workPhoneNumberstring
mailingAddressobject(Address)

The guest's mailing address

billingAddressobject(Address)

The guest's billing address

curl -i -X PATCH \
  https://tbg-api-docs.vacatia.com/_mock/berkley/owners/V-0000-0000 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "salutation": "Mr.",
    "emailAddress": "user@example.com",
    "homePhoneNumber": "string",
    "mobilePhoneNumber": "string",
    "workPhoneNumber": "string",
    "mailingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    },
    "billingAddress": {
      "line1": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "postalCode": "string",
      "country": "string"
    }
  }'

Responses

The updated owner id

Bodyapplication/json
dataobject(OwnerResponse)
Response
application/json
{
  "data": {
    "id": "V-0000-0000"
  }
}

Properties

Operations

Contracts

Operations

Reservations

Operations

Guests

Operations