Update a handbook article

Workforce module

PATCH/handbook-articles/{id}handbookArticles.update

A handbook or SOP article: versioned on publish, optionally a mandatory read acknowledged per version. 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

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

Request body: HandbookArticleUpdate

handbookArticles.update: HandbookArticleUpdate
Field	Type	Required	Description
handbook_section_id	string (uuid) \| null	No	Identifier of the section.
title	string	No	Title.Constraints: length 1 to 200
body	string	No	Working text; members read the published version.Constraints: length 1 to 20000
is_mandatory	boolean	No	Whether every member must acknowledge the current version.

{
  "handbook_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Hearing protection",
  "body": "Wear hearing protection near the stacks.",
  "is_mandatory": true
}

Response 200: HandbookArticle

handbookArticles.update: HandbookArticle
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the handbook article.
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	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Person who last updated the row; null for seed, platform or system writes.
handbook_section_id	string (uuid) \| null	Yes	Identifier of the section.
title	string	Yes	Title.Constraints: length 1 to 200
body	string	Yes	Working text; members read the published version.Constraints: length 1 to 20000
is_mandatory	boolean	Yes	Whether every member must acknowledge the current version.
article_state	"Draft" \| "Published" \| "Archived"	Yes	Article state.
published_version	integer	Yes	Latest published version.Constraints: range 0 to any
published_at	string (date-time) \| null	Yes	When the latest version was published.

{
  "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",
  "handbook_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Hearing protection",
  "body": "Wear hearing protection near the stacks.",
  "is_mandatory": true,
  "article_state": "Draft",
  "published_version": 1,
  "published_at": "2026-10-08T14:30:00Z"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/handbook-articles/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 '{"handbook_section_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Hearing protection","body":"Wear hearing protection near the stacks.","is_mandatory":true}'

const { data, etag } = await xos.handbookArticles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "handbook_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "title": "Hearing protection",
    "body": "Wear hearing protection near the stacks.",
    "is_mandatory": true
  }, { ifMatch: etag });

response = xos.handbook_articles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"handbook_section_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "title": "Hearing protection", "body": "Wear hearing protection near the stacks.", "is_mandatory": True}, if_match=etag)

xos handbook-articles update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"handbook_section_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","title":"Hearing protection","body":"Wear hearing protection near the stacks.","is_mandatory":true}' --if-match auto