Vacatia API Catalog
/
Cloudbeds API
/
Groups
/
patchGroup

Cloudbeds API (v1.2)

Welcome to the documentation for Cloudbeds API Version v1.2! If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data for your Cloudbeds customers, then you've come to the right place.

In this document you will find all the API methods we provide along with explanations for parameters and response examples.

If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our Integrations Portal.

Be sure to subscribe to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.

Endpoint: https://api.cloudbeds.com/api/v1.2/{method}

HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.

Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)

Response Format: JSON

Response Header: X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.

Run in Postman use this link to access our Public collection in Postman.

Download OpenAPI description
cloudbeds.json
cloudbeds.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/cloudbeds/
https://api.cloudbeds.com/api/v1.2/

Authentication

Operations

Adjustment

Operations

AllotmentBlocks

Operations

AppSettings

Operations

Currency

Operations

CustomFields

Operations

Dashboard

Operations

Emails

Operations

Groups

Operations

getGroupNotes

Request

Returns group notes

Query
propertyIDstringrequired

Property ID

groupCodestringrequired

Group code

pageSizeintegerrequired

Number of groups notes to return per page (min: 1, max: 100)

pageNumberintegerrequired

Which page in the results to access

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getGroupNotes?groupCode=string&pageNumber=0&pageSize=0&propertyID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Success

codeinteger

HTTP status code

dataobject

Data

Response
application/json
{
  "success": true,
  "code": 0,
  "data": {
    "id": "string",
    "group_profile_id": "string",
    "text": "string",
    "created_by": "string",
    "created_at": "string",
    "updated_at": "string",
    "archived": true,
    "archived_at": "string"
  }
}

getGroups

Request

Returns the groups for a property

Query
propertyIDstringrequired

Property ID

groupCodestring

Unique ID for a group

typestring

The type of group

Enum"group""company""travel_agent""wholesaler"
statusstring

Group status

Enum"open""closed"
createdFromstring(date-time)

Datetime (lower limit) to be queried

createdTostring(date-time)

Datetime (upper limit) to be queried

pageSizeinteger

Number of groups to return per page (min: 1, max: 100)

pageNumberinteger

Which page in the results to access

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getGroups?createdFrom=2019-08-24T14%3A15%3A22Z&createdTo=2019-08-24T14%3A15%3A22Z&groupCode=string&pageNumber=0&pageSize=0&propertyID=string&status=open&type=group' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Success

dataArray of objects

Data

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

patchGroup

Request

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

Bodyapplication/x-www-form-urlencoded
groupCodestring

code for a group

propertyIDstring

Property ID

namestring

Name for a group

typestring

The type of group

Enum"group""company""travel_agent""wholesaler"
statusstring

Group status

Enum"open""closed"
sourceIDstring

Source ID for a group

address1string

Address line 1 for a group

address2string

Address line 2 for a group

citystring

City for a group

zipstring

Zip for a group

statestring

State for a group

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/patchGroup \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d groupCode=string \
  -d propertyID=string \
  -d name=string \
  -d type=group \
  -d status=open \
  -d sourceID=string \
  -d address1=string \
  -d address2=string \
  -d city=string \
  -d zip=string \
  -d state=string

Responses

200 Response

Bodyapplication/json
successboolean

Success

dataArray of objects

Data

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

postGroupNote

Request

Adds a group note

Bodyapplication/x-www-form-urlencoded
propertyIDstring

Property ID

groupCodestring

Group code

groupNotestring

Group note

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postGroupNote \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d propertyID=string \
  -d groupCode=string \
  -d groupNote=string

Responses

200 Response

Bodyapplication/json
successboolean

Success

codeinteger

code HTTP status code

dataArray of objects

Data

Response
application/json
{
  "success": true,
  "code": 0,
  "data": [
    { … }
  ]
}

putGroup

Request

Adds a group to the property. Please note that the default setting for 'Route to Group Folio' will be 'No,' and the 'Reservation Folio Configuration' will be set as the default folio configuration. You can edit these settings through the user interface (UI).

Bodyapplication/x-www-form-urlencoded
propertyIDstring

Property ID

namestring

Name for a group

typestring

The type of group

Enum"group""company""travel_agent""wholesaler"
statusstring

Group status

Enum"open""closed"
commissionTypestring

Commission Type

Enum"fixed""percent"
sourceIDstring

Source ID for a group

address1string or null

Address line 1 for a group

address2string or null

Address line 2 for a group

citystring or null

City for a group

zipstring or null

Zip for a group

statestring or null

State for a group

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/putGroup \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d propertyID=string \
  -d name=string \
  -d type=group \
  -d status=open \
  -d commissionType=fixed \
  -d sourceID=string \
  -d address1=string \
  -d address2=string \
  -d city=string \
  -d zip=string \
  -d state=string

Responses

200 Response

Bodyapplication/json
successboolean

Success

dataArray of objects

Data

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ]
}

Guest

Operations

Hotel

Operations

HouseAccount

Operations

Housekeeping

Operations

Integration

Operations

Invoices

Operations

Item

Operations

Package

Operations

Payment

Operations

Rate

Operations

Reservation

Operations

Room

Operations

Taxes and Fees

Operations

User

Operations