Acknowledge an article
Workforce module
POST/handbook-articles/{id}/acknowledgehandbookArticles.acknowledge
Records that the caller read the current version. 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.acknowledge.
- 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 handbook article. |
Response 200: 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 POST "$XOS_BASE_URL/handbook-articles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/acknowledge" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.handbookArticles.acknowledge("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.handbook_articles.acknowledge("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos handbook-articles acknowledge 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f