CLcloudbeds
AllotmentBlocks

createAllotmentBlock

Changed on

Retreive allotment blocks @apiQuery {Integer} propertyID Property ID

post/createAllotmentBlock

Request

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

Request body application/x-www-form-urlencoded

eventCodestring

The unique identifier of the event the allotment block should be created

allotmentBlockNamestring

The name for the allotment block

rateType'base_rate' | 'rate_plan' | 'custom'

The rate type for the associated intervals

ratePlanIdstring nullable

The rate plan ID. Required if rateType is "rate_plan".

allotmentType'allotment' | 'based_on_availability'

The allotment type

allotmentBlockStatus'definite' | 'tentative' | 'lead'

The status for the allotment block under

allowOverbookingboolean nullable

If false, or omitted, then this command will fail if it would result in an overbooking. If true, then the update will succeed even if it results in an overbooking.

Response

200 Response

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

Changes