APapaleo
Block

Creates a block

Changed on

<br>You must have at least one of these scopes: 'blocks.create, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.blocks.create'.

post/booking/v1/blocks

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/booking/v1/blocks
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: blocks.create, reservations.manage, admin

Headers

Idempotency-Keystring

Unique key for safely retrying requests without accidentally performing the same operation twice. We'll always send back the same response for requests made with the same key, and keys can't be reused with different request parameters. Keys expire after 24 hours.

Request body

groupIdstring required

ID of the group that reserved the block

ratePlanIdstring required

The rate plan

fromstring required

Start date and time from which the inventory will be blocked<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring required

End date and time until which the inventory will be blocked. Cannot be more than 5 years after the start date.<br />Specify either a pure date or a date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

blockedUnitsinteger nullable

Number of units to block for the defined time period

promoCodestring nullable

The promo code associated with a certain special offer

corporateCodestring nullable

The corporate code associated with a certain special offer

marketSegmentIdstring nullable

The market segment Id for this block. Must be a valid market segment ID defined at the property level. Picked-up reservations will inherit this value by default

Example request

{
  "groupId": "XPGMSXGF",
  "ratePlanId": "MUC-NONREF-SGL",
  "from": "2026-10-20",
  "to": "2026-10-23",
  "grossDailyRate": {
    "amount": 160,
    "currency": "EUR"
  },
  "timeSlices": [
    {
      "blockedUnits": 3
    },
    {
      "blockedUnits": 0
    },
    {
      "blockedUnits": 7
    }
  ],
  "marketSegmentId": "BUSR"
}

Response

The block was created successfully.

idstring required

Block id

Example response

{
  "id": "MUC-HSGTDG"
}

Changes