Create an availability block
Gateway module
POST/availability-blocksavailabilityBlocks.create
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.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: AvailabilityBlockCreate
| Field | Type | Required | Description |
|---|---|---|---|
| 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 | No | Private note of the owner.Constraints: length 1 to 2000 |
{
"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."
}Response 201: 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 POST "$XOS_BASE_URL/availability-blocks" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"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."}'const { data } = await xos.availabilityBlocks.create({
"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."
});response = xos.availability_blocks.create({"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."})xos availability-blocks create --data '{"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."}'