APapaleo
BlockActions

Convert an optional block to tentative when its booking window opens.

Changed on

Internal callback the scheduler invokes when an 'Optional' block's start timer fires. It releases the block ('Optional' to 'Tentative'). A stale fire - the block already left 'Optional', or its stored start no longer matches the payload - is a no-op.<br>You must have at least one of these scopes: 'blocks.manage, reservations.manage'.

put/booking/v1/block-actions/{id}/start-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/v1/block-actions/{id}/start-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

expectedStartDateUtcstring date-time required

The block start timestamp the scheduler fired for. It is compared against the block's stored start so a stale or replayed callback (the start was moved, or the block already left 'Optional') is ignored.<br />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>

Response

The callback was applied, or was a no-op for a stale fire.

Changes