Create a capability document

Módulo Places

POST/capability-documentscapabilityDocuments.create

A venue capability document with a validity window. A frozen document cannot change. Creates a capability document. 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 places.capability_document.write.
Alcances de OAuth: places.
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: CapabilityDocumentCreate

capabilityDocuments.create: CapabilityDocumentCreate
Campo	Tipo	Obligatorio	Descripción
venue_id	string (uuid)	Sí	Identifier of the venue.
valid_from	string (date)	Sí	First day the document is valid.
valid_to	string (date) \| null	No	Last day the document is valid.
title	string	Sí	Document title.Restricciones: length 1 to 300
document_uri	string	Sí	Where the document is stored.Restricciones: length 1 to 2000

{
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_from": "2026-10-08",
  "valid_to": "2026-10-08",
  "title": "Tech Pack 2027",
  "document_uri": "https://docs.example.com/tech-pack.pdf"
}

Respuesta 201: CapabilityDocument

capabilityDocuments.create: CapabilityDocument
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the capability document.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
venue_id	string (uuid)	Sí	Identifier of the venue.
valid_from	string (date)	Sí	First day the document is valid.
valid_to	string (date) \| null	Sí	Last day the document is valid.
frozen	boolean	Sí	Whether the document is frozen.
title	string	Sí	Document title.Restricciones: length 1 to 300
document_uri	string	Sí	Where the document is stored.Restricciones: length 1 to 2000

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "valid_from": "2026-10-08",
  "valid_to": "2026-10-08",
  "frozen": false,
  "title": "Tech Pack 2027",
  "document_uri": "https://docs.example.com/tech-pack.pdf"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/capability-documents" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08","valid_to":"2026-10-08","title":"Tech Pack 2027","document_uri":"https://docs.example.com/tech-pack.pdf"}'

const { data } = await xos.capabilityDocuments.create({
    "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "valid_from": "2026-10-08",
    "valid_to": "2026-10-08",
    "title": "Tech Pack 2027",
    "document_uri": "https://docs.example.com/tech-pack.pdf"
  });

response = xos.capability_documents.create({"venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "valid_from": "2026-10-08", "valid_to": "2026-10-08", "title": "Tech Pack 2027", "document_uri": "https://docs.example.com/tech-pack.pdf"})

xos capability-documents create --data '{"venue_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","valid_from":"2026-10-08","valid_to":"2026-10-08","title":"Tech Pack 2027","document_uri":"https://docs.example.com/tech-pack.pdf"}'