Update a SOP

Knowledge module

PATCH/sops/{id}sops.update

A standard operating procedure that members acknowledge. 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 knowledge.sop.write.
OAuth scopes: knowledge.
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

sops.update: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the sop.

Request body: SopUpdate

sops.update: SopUpdate
Field	Type	Required	Description
title	string	No	SOP title.Constraints: length 1 to 300
body	string	No	Procedure text.Constraints: length 1 to 20000

{
  "title": "Working at Height",
  "body": "Confirm the dock slot, then stage by department."
}

Response 200: Sop

sops.update: 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 PATCH "$XOS_BASE_URL/sops/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 '{"title":"Working at Height","body":"Confirm the dock slot, then stage by department."}'

const { data, etag } = await xos.sops.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "title": "Working at Height",
    "body": "Confirm the dock slot, then stage by department."
  }, { ifMatch: etag });

response = xos.sops.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"title": "Working at Height", "body": "Confirm the dock slot, then stage by department."}, if_match=etag)

xos sops update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"title":"Working at Height","body":"Confirm the dock slot, then stage by department."}' --if-match auto