Saltar al contenido

Create a handbook section

Módulo Workforce

POST/handbook-sectionshandbookSections.create

A chapter of the org handbook. Creates a handbook section. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad knowledge.sop.write.
  • 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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: HandbookSectionCreate

handbookSections.create: HandbookSectionCreate
CampoTipoObligatorioDescripción
namestringSíSection name.Restricciones: length 1 to 120
positionintegerSíOrder.Restricciones: range 1 to any
{
  "name": "Site rules",
  "position": 1
}

Respuesta 201: HandbookSection

handbookSections.create: HandbookSection
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the handbook section.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
namestringSíSection name.Restricciones: length 1 to 120
positionintegerSíOrder.Restricciones: 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
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/handbook-sections" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Site rules","position":1}'
const { data } = await xos.handbookSections.create({
    "name": "Site rules",
    "position": 1
  });
response = xos.handbook_sections.create({"name": "Site rules", "position": 1})
xos handbook-sections create --data '{"name":"Site rules","position":1}'