Vacatia API Catalog
/
Cloudbeds API
/
AllotmentBlocks
/
updateAllotmentBlockNotes

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

createAllotmentBlock

Request

Retreive allotment blocks @apiQuery {Integer} propertyID Property ID

Bodyapplication/x-www-form-urlencoded
groupCodestring

The unique identifier of the group profile the allotment block should be created

allotmentBlockNamestring

The name for the allotment block

rateTypestring

The rate type for the associated intervals

Enum"base_rate""rate_plan""custom"
allotmentTypestring

The allotment type

Enum"allotment""based_on_availability"
allotmentBlockStatusstring

The status for the allotment block under

Enum"definite""tentative""lead"
autoReleaseobject or null

Optional auto-release configuration

allotmentIntervalsArray of objects or null

The day-based data for the allotment block.

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/createAllotmentBlock \
  -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 allotmentBlockName=string \
  -d rateType=base_rate \
  -d allotmentType=allotment \
  -d allotmentBlockStatus=definite \
  -d 'autoRelease[releaseType]=all_dates' \
  -d 'autoRelease[days]=0' \
  -d 'autoRelease[releaseTime]=string' \
  -d 'allotmentIntervals=[object Object]'

Responses

200 Response

Bodyapplication/json
startDatestring(date)

Date on or after which each returned allotmentBlock applies

endDatestring(date)

Date on or before which each returned allotmentBlock applies

successboolean

Returns if the request could be completed

dataArray of objects

Allotment Blocks

Response
application/json
{
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "success": true,
  "data": [
    { … }
  ]
}

deleteAllotmentBlock

Request

Delete allotment blocks

Bodyapplication/x-www-form-urlencoded
allotmentBlockCodestring

The unique code of the allotment Block

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

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

Response
application/json
{
  "success": true
}

getAllotmentBlocks

Request

Retrieve allotment blocks

Query
propertyIDstringrequired

Property ID (optional, by default all authorized properties will be included)

allotmentBlockCodestring

Allotment block code

allotmentBlockNamestring

Allotment block name

groupCodestring

A group profile code

allotmentBlockStatusstring

Allotment block status(es)

Enum"definite""tentative""lead""cancelled"
allotmentBlockTypestring

The type of allotment block

Enum"aggregate""allotment"
pageSizeinteger

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

pageNumberinteger

Which page in the results to access

startDatestring(date)

Interval start date

endDatestring(date)

Interval start date

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getAllotmentBlocks?allotmentBlockCode=string&allotmentBlockName=string&allotmentBlockStatus=definite&allotmentBlockType=aggregate&endDate=2019-08-24&groupCode=string&pageNumber=0&pageSize=0&propertyID=string&startDate=2019-08-24' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

countinteger

Number of allotment blocks returned

totalinteger

Total number of allotment blocks

dataArray of objects

Allotment Blocks

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

updateAllotmentBlock

Request

Update an allotment block @apiQuery {Integer} propertyID Property ID

Bodyapplication/x-www-form-urlencoded
allotmentBlockCodestring

The allotment block code identifying the allotment block to update

allotmentBlockNamestring or null

The name for the allotment block

allotmentTypestring or null

The allotment type

Enum"allotment""based_on_availability"
allotmentBlockStatusstring or null

The status for the allotment block under

Enum"definite""tentative""lead""cancelled"
autoReleaseobject or null

Optional auto-release configuration NOTE: pass empty object to remove auto-release configuration

allotmentIntervalsArray of objects or null

The day-based data for the allotment block.

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/updateAllotmentBlock \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d allotmentBlockCode=string \
  -d allotmentBlockName=string \
  -d allotmentType=allotment \
  -d allotmentBlockStatus=definite \
  -d 'autoRelease[releaseType]=all_dates' \
  -d 'autoRelease[days]=0' \
  -d 'autoRelease[releaseTime]=string' \
  -d 'allotmentIntervals=[object Object]'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataArray of objects

Allotment Blocks

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

createAllotmentBlockNotes

Request

Add a note to an allotment block

Bodyapplication/x-www-form-urlencoded
propertyIDstring

Property ID

allotmentBlockCodestring

Allotment Block Code

textstring

Note's text

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/createAllotmentBlockNotes \
  -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 allotmentBlockCode=string \
  -d text=string

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject

The created note

Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "text": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "2019-08-24T14:15:22Z",
    "status": "string"
  }
}

listAllotmentBlockNotes

Request

List notes added to an allotment block

Query
propertyIDstringrequired

Property ID

allotmentBlockCodestringrequired

Allotment block code

statusstring

Note status

Enum"all""active""archived"
pageNumberinteger

Page

pageSizeinteger

Number of Items per Page (min 1, max 100)

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

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataArray of objects

List of notes

pageSizeinteger

Number of Notes per Page

pageNumberinteger

Current page

totalinteger

Total number of Notes

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

updateAllotmentBlockNotes

Request

Update a note on an allotment block

Bodyapplication/x-www-form-urlencoded
propertyIDstring

Property ID

allotmentBlockCodestring

Allotment Block Code

noteIDstring

Note's ID

textstring or null

Note's text (null for no change)

statusstring or null

Note status

Enum"active""archived"
curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/updateAllotmentBlockNotes \
  -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 allotmentBlockCode=string \
  -d noteID=string \
  -d text=string \
  -d status=active

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject

The created note

Response
application/json
{
  "success": true,
  "data": {
    "id": "string",
    "text": "string",
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "archivedAt": "2019-08-24T14:15:22Z",
    "status": true
  }
}

AppSettings

Operations

Currency

Operations

CustomFields

Operations

Dashboard

Operations

Emails

Operations

Groups

Operations

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