Update a handbook section

Workforce module

PATCH/handbook-sections/{id}handbookSections.update

A chapter of the org handbook. 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

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

Request body: HandbookSectionUpdate

handbookSections.update: HandbookSectionUpdate
Field	Type	Required	Description
name	string	No	Section name.Constraints: length 1 to 120
position	integer	No	Order.Constraints: range 1 to any

{
  "name": "Site rules",
  "position": 1
}

Response 200: HandbookSection

handbookSections.update: HandbookSection
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the handbook section.
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.
name	string	Yes	Section name.Constraints: length 1 to 120
position	integer	Yes	Order.Constraints: range 1 to any

{
  "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",
  "name": "Site rules",
  "position": 1
}

Code samples

curl -X PATCH "$XOS_BASE_URL/handbook-sections/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 '{"name":"Site rules","position":1}'

const { data, etag } = await xos.handbookSections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "name": "Site rules",
    "position": 1
  }, { ifMatch: etag });

response = xos.handbook_sections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"name": "Site rules", "position": 1}, if_match=etag)

xos handbook-sections update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"name":"Site rules","position":1}' --if-match auto