Create an availability block

Módulo Gateway

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.

Requiere la capacidad me.profile.write.
Alcances de OAuth: me.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: AvailabilityBlockCreate

availabilityBlocks.create: AvailabilityBlockCreate
Campo	Tipo	Obligatorio	Descripción
availability_calendar_id	string (uuid)	Sí	Identifier of the availability calendar.
starts_at	string (date-time)	Sí	Block start.
ends_at	string (date-time)	Sí	Block end.
availability_kind	"Available" \| "Unavailable" \| "Tentative"	Sí	Kind of block.
note	string \| null	No	Private note of the owner.Restricciones: 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."
}

Respuesta 201: AvailabilityBlock

availabilityBlocks.create: AvailabilityBlock
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the availability block.
created_at	string (date-time)	Sí	When the row was created.
updated_at	string (date-time)	Sí	When the row was last updated.
availability_calendar_id	string (uuid)	Sí	Identifier of the availability calendar.
starts_at	string (date-time)	Sí	Block start.
ends_at	string (date-time)	Sí	Block end.
availability_kind	"Available" \| "Unavailable" \| "Tentative"	Sí	Kind of block.
note	string \| null	Sí	Private note of the owner.Restricciones: 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."
}

Ejemplos de código

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."}'