Publish an article

Módulo Workforce

POST/handbook-articles/{id}/publishhandbookArticles.publish

Publishes the working text as the next version; a mandatory article then asks everyone to acknowledge it. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

Requiere la capacidad knowledge.sop.publish.
Alcances de OAuth: knowledge.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

handbookArticles.publish: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the handbook article.

Cuerpo de la solicitud: PublishArticleRequest

handbookArticles.publish: PublishArticleRequest
Campo	Tipo	Obligatorio	Descripción
change_summary	string	No	What changed.Restricciones: length 0 to 500

{
  "change_summary": "Added the distance."
}

Respuesta 200: HandbookArticle

handbookArticles.publish: HandbookArticle
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the handbook article.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Person who created the row; null for seed, platform or system writes.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Person who last updated the row; null for seed, platform or system writes.
handbook_section_id	string (uuid) \| null	Sí	Identifier of the section.
title	string	Sí	Title.Restricciones: length 1 to 200
body	string	Sí	Working text; members read the published version.Restricciones: length 1 to 20000
is_mandatory	boolean	Sí	Whether every member must acknowledge the current version.
article_state	"Draft" \| "Published" \| "Archived"	Sí	Article state.
published_version	integer	Sí	Latest published version.Restricciones: range 0 to any
published_at	string (date-time) \| null	Sí	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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/handbook-articles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/publish" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"change_summary":"Added the distance."}'

const { data } = await xos.handbookArticles.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "change_summary": "Added the distance."
  });

response = xos.handbook_articles.publish("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"change_summary": "Added the distance."})

xos handbook-articles publish 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"change_summary":"Added the distance."}'