Update an availability block

Gateway module

PATCH/availability-blocks/{id}availabilityBlocks.update

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.

Requires the capability me.profile.write.
OAuth scopes: me.
Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

availabilityBlocks.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the availability block.

Request body: AvailabilityBlockUpdate

availabilityBlocks.update: AvailabilityBlockUpdate
Field	Type	Required	Description
starts_at	string (date-time)	No	Block start.
ends_at	string (date-time)	No	Block end.
availability_kind	"Available" \| "Unavailable" \| "Tentative"	No	Kind of block.
note	string \| null	No	Private note of the owner.Constraints: length 1 to 2000

{
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "availability_kind": "Available",
  "note": "Holding for a tour."
}

Response 200: AvailabilityBlock

availabilityBlocks.update: AvailabilityBlock
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the availability block.
created_at	string (date-time)	Yes	When the row was created.
updated_at	string (date-time)	Yes	When the row was last updated.
availability_calendar_id	string (uuid)	Yes	Identifier of the availability calendar.
starts_at	string (date-time)	Yes	Block start.
ends_at	string (date-time)	Yes	Block end.
availability_kind	"Available" \| "Unavailable" \| "Tentative"	Yes	Kind of block.
note	string \| null	Yes	Private note of the owner.Constraints: length 1 to 2000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "updated_at": "2026-10-08T14:30:00Z",
  "availability_calendar_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_at": "2026-10-08T14:30:00Z",
  "ends_at": "2026-10-08T14:30:00Z",
  "availability_kind": "Available",
  "note": "Holding for a tour."
}

Code samples

curl -X PATCH "$XOS_BASE_URL/availability-blocks/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","availability_kind":"Available","note":"Holding for a tour."}'

const { data, etag } = await xos.availabilityBlocks.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "starts_at": "2026-10-08T14:30:00Z",
    "ends_at": "2026-10-08T14:30:00Z",
    "availability_kind": "Available",
    "note": "Holding for a tour."
  }, { ifMatch: etag });

response = xos.availability_blocks.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"starts_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z", "availability_kind": "Available", "note": "Holding for a tour."}, if_match=etag)

xos availability-blocks update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","availability_kind":"Available","note":"Holding for a tour."}' --if-match auto