Publish an SOP
Knowledge module
POST/sops/{id}/publishsops.publish
Publishes the SOP: the database stamps `published_at` and raises `version` when it was published before, so everyone is asked to acknowledge the new version. Needs knowledge.sop.publish. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability knowledge.sop.publish.
- OAuth scopes: knowledge.
- 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 sop. |
Response 200: Sop
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the sop. |
| 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. |
| title | string | Yes | SOP title.Constraints: length 1 to 300 |
| body | string | Yes | Procedure text.Constraints: length 1 to 20000 |
| code | string | Yes | SOP code, SOP- and three to five digits.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| version | integer | Yes | Version number, raised on each publish.Constraints: range 1 to any |
| published_at | string (date-time) | null | Yes | When the current version was published; null while draft. |
{
"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",
"title": "Working at Height",
"body": "Confirm the dock slot, then stage by department.",
"code": "SOP-001",
"version": 1,
"published_at": "2026-10-08T14:30:00Z"
}Code samples
curl -X POST "$XOS_BASE_URL/sops/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/publish" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.sops.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.sops.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos sops publish 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f