BlockActions

Allow to modify a block

Use this call to modify a block.<br>You must have at least one of these scopes: 'blocks.manage, reservations.manage'.<br>For fine-grained clients, you must have this permission: 'core.blocks.amend'.

put/booking/v0-nsfw/block-actions/{id}/amend

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/v0-nsfw/block-actions/{id}/amend
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: blocks.manage, reservations.manage, admin

Path parameters

idstring required

Id of the block to be modified.

Request body

fromstring required

Start date and time from which the inventory will be blocked<br />Specify either a pure date or a date and time 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 in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

status'Tentative' | 'Definite' | 'Canceled' | 'Optional' nullable

The status to transition the block to as part of this edit. When omitted, the block keeps its current status and the amend is a plain update. 'Canceled' is not supported here; use the cancel action. Changing the status to Optional requires OptionalCutoff, IsOptionalDeductingInventory and OptionalCutoffBehavior.

optionalCutoffstring nullable

The date and time by which a decision should be made on this optional block. Required when changing the block's status to Optional.<br />Specify either a pure date or a date and time in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

isOptionalDeductingInventoryboolean nullable

Whether this optional block reduces availability like a definite block. Required when changing the block's status to Optional.

optionalCutoffBehavior'DoNothing' | 'AutoRelease' nullable

What happens when the optional cutoff date is reached. Required when changing the block's status to Optional.

Example request

{
  "from": "2026-11-04",
  "to": "2026-11-07",
  "grossDailyRate": {
    "amount": 160,
    "currency": "EUR"
  },
  "timeSlices": [
    {
      "blockedUnits": 3
    },
    {
      "blockedUnits": 0
    },
    {
      "blockedUnits": 7
    }
  ]
}

Response

Replace of the block was successful.

Changes

No operation changes recorded.