postRoomBlock

post

https://api.cloudbeds.com/api/v1.3/postRoomBlock

Adds a room block to the selected property.

Form Data

propertyID

string | null

Property ID

roomBlockType

string

enum

Room block type. ‘blocked’ - Room block. ‘out_of_service’ - Out of service block. 'courtesy_hold' - Courtesy hold block.

Allowed:

roomBlockReason

string

Room block reason

startDate

date

Room block start date

endDate

date

Room block end date

rooms

array of objects

All rooms for room block. When multiple rooms are submitted they will be created under the same roomBlockID. For properties using split inventory (virtual rooms linked to physical rooms), only provide the source rooms you want to block. Linked rooms will be automatically added. Do not include auto-added linked rooms in the request - the API will reject requests that include both a source room and its linked room(s).

rooms

firstName

string | null

First name - for courtesy hold updates

lastName

string | null

Last name - for courtesy hold updates

lengthOfHoldInHours

integer | null

Length of hold in hours - for courtesy hold updates

string | null

Email address - for courtesy hold updates

phone

string | null

Phone number - for courtesy hold updates

Response

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response