APapaleo
BlockActions

Set a block to optional.

Set a specific block which is in status 'Tentative' to 'Optional'.<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.set_to_optional'.

put/booking/v0-nsfw/block-actions/{id}/set-to-optional

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}/set-to-optional
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: blocks.manage, reservations.manage, admin

Path parameters

idstring required

Id of the block that should be processed.

Request body

optionalCutoffstring required

The date (or date and time) by which a decision must be made on this optional block. A bare date is interpreted as the end of that day in the property's time zone.<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 required

Whether this optional block reduces availability like a definite block

optionalCutoffBehavior'DoNothing' | 'AutoRelease' required

What happens when the optional cutoff date is reached

Response

Setting the block to optional was successful.

Changes

No operation changes recorded.