Update a capability document
Places module
PATCH/capability-documents/{id}capabilityDocuments.update
A venue capability document with a validity window. A frozen document cannot change. 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 places.capability_document.write.
- OAuth scopes: places.
- 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
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the capability document. |
Request body: CapabilityDocumentUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| valid_from | string (date) | No | First day the document is valid. |
| valid_to | string (date) | null | No | Last day the document is valid. |
| title | string | No | Document title.Constraints: length 1 to 300 |
| document_uri | string | No | Where the document is stored.Constraints: length 1 to 2000 |
{
"valid_from": "2026-10-08",
"valid_to": "2026-10-08",
"title": "Tech Pack 2027",
"document_uri": "https://docs.example.com/tech-pack.pdf"
}Response 200: CapabilityDocument
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the capability document. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| venue_id | string (uuid) | Yes | Identifier of the venue. |
| valid_from | string (date) | Yes | First day the document is valid. |
| valid_to | string (date) | null | Yes | Last day the document is valid. |
| frozen | boolean | Yes | Whether the document is frozen. |
| title | string | Yes | Document title.Constraints: length 1 to 300 |
| document_uri | string | Yes | Where the document is stored.Constraints: 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"
}Code samples
curl -X PATCH "$XOS_BASE_URL/capability-documents/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 '{"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, etag } = await xos.capabilityDocuments.update("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"
}, { ifMatch: etag });response = xos.capability_documents.update("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"}, if_match=etag)xos capability-documents update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"valid_from":"2026-10-08","valid_to":"2026-10-08","title":"Tech Pack 2027","document_uri":"https://docs.example.com/tech-pack.pdf"}' --if-match auto