Saltar al contenido

Create an approval step

Módulo Platform

POST/approval-stepsapprovalSteps.create

An ordered step of an approval policy (1030). It names its approvers: everyone holding a role, or one member. Steps change only while the policy is a Draft (approval_step_policy_not_draft: 422). Creates an approval step. 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 org.approval_policies.write.
  • Alcances de OAuth: org.
  • 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: ApprovalStepCreate

approvalSteps.create: ApprovalStepCreate
CampoTipoObligatorioDescripción
approval_policy_idstring (uuid)SíIdentifier of the approval policy.
step_orderintegerSíPosition of the step, 1 first; steps are decided in order.Restricciones: range 1 to any
namestringSíStep name.Restricciones: length 1 to 200
approver_role_idstring (uuid) | nullNoIdentifier of the role whose holders decide the step.
approver_membership_idstring (uuid) | nullNoIdentifier of the the one member who decides the step.
{
  "approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "step_order": 1,
  "name": "Department head",
  "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "approver_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 201: ApprovalStep

approvalSteps.create: ApprovalStep
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the approval step.
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íIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
approval_policy_idstring (uuid)SíIdentifier of the approval policy.
step_orderintegerSíPosition of the step, 1 first; steps are decided in order.Restricciones: range 1 to any
namestringSíStep name.Restricciones: length 1 to 200
approver_role_idstring (uuid) | nullSíIdentifier of the role whose holders decide the step.
approver_membership_idstring (uuid) | nullSíIdentifier of the the one member who decides the step.
{
  "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",
  "approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "step_order": 1,
  "name": "Department head",
  "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "approver_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/approval-steps" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"approval_policy_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","step_order":1,"name":"Department head","approver_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","approver_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data } = await xos.approvalSteps.create({
    "approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "step_order": 1,
    "name": "Department head",
    "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "approver_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  });
response = xos.approval_steps.create({"approval_policy_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "step_order": 1, "name": "Department head", "approver_role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "approver_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})
xos approval-steps create --data '{"approval_policy_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","step_order":1,"name":"Department head","approver_role_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","approver_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'