Freeze a capability document
Places module
POST/capability-documents/{id}/freezecapabilityDocuments.freeze
Freezes the document so its content and validity window can no longer change. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability places.capability_document.write.
- OAuth scopes: places.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the capability document. |
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 POST "$XOS_BASE_URL/capability-documents/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/freeze" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.capabilityDocuments.freeze("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.capability_documents.freeze("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos capability-documents freeze 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f