Skip to content
XOS Developers

Delete an approval step

Platform module

DELETE/approval-steps/{id}approvalSteps.delete

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). Soft-deletes the approval step: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.approval_policies.write.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

approvalSteps.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the approval step.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/approval-steps/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.approvalSteps.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.approval_steps.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos approval-steps delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f