CLcloudbeds
Room

postRoomBlock

Adds a room block to the selected property.

post/postRoomBlock

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/postRoomBlock
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: write:roomblock

Request body application/x-www-form-urlencoded

propertyIDstring nullable

Property ID

roomBlockType'blocked_dates' | 'out_of_service' | 'courtesy_hold'

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

roomBlockReasonstring

Room block reason

startDatestring date

Room block start date

endDatestring date

Room block end date

firstNamestring nullable

First name - for courtesy hold updates

lastNamestring nullable

Last name - for courtesy hold updates

lengthOfHoldInHoursinteger nullable

Length of hold in hours - for courtesy hold updates

emailstring nullable

Email address - for courtesy hold updates

phonestring nullable

Phone number - for courtesy hold updates

Response

200 Response

successboolean

Returns if the request could be completed

propertyIDstring

Property ID

roomBlockIDstring

Room block ID

roomBlockType'blocked_dates' | 'out_of_service' | 'courtesy_hold'

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

roomBlockReasonstring

Room block reason

startDatestring date

Room block start date

endDatestring date

Room block end date

messagestring

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

No recorded changes to this operation across all 2 revisions of this API.