Skip to content
XOS Developers

availabilityBlocks

Gateway module · 5 operations

List availability block rows

GET/availability-blocks

A block of availability or unavailability. Returns a cursor page of availability block rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an availability block

POST/availability-blocks

A block of availability or unavailability. Creates an availability block. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get an availability block

GET/availability-blocks/{id}

A block of availability or unavailability. Returns one availability block with its `ETag`. A availability block the caller may not see returns 404.

Update an availability block

PATCH/availability-blocks/{id}

A block of availability or unavailability. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an availability block

DELETE/availability-blocks/{id}

A block of availability or unavailability. Soft-deletes the availability block: it moves to Trash and can be restored for its table's retention period.