Skip to content

Create an approval decision

Platform module

POST/approval-decisionsapprovalDecisions.create

A decision by an eligible approver, never the requester. Creates an approval decision. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability inbox.notifications.write.
  • OAuth scopes: inbox.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ApprovalDecisionCreate

approvalDecisions.create: ApprovalDecisionCreate
FieldTypeRequiredDescription
approval_instance_idstring (uuid)YesIdentifier of the approval instance.
approvedbooleanYesWhether the step is approved.
commentstring | nullNoDecision comment.Constraints: length 1 to 20000
{
  "approval_instance_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "approved": true,
  "comment": "Within budget."
}

Response 201: ApprovalDecision

approvalDecisions.create: ApprovalDecision
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the approval decision.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
approval_instance_idstring (uuid)YesIdentifier of the approval instance.
approvedbooleanYesWhether the step is approved.
commentstring | nullYesDecision comment.Constraints: length 1 to 20000
approver_idstring (uuid)YesIdentifier of the approver.
decided_atstring (date-time)YesWhen it was decided.
step_orderintegerYesStep decided.Constraints: 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",
  "approval_instance_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "approved": true,
  "comment": "Within budget.",
  "approver_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "decided_at": "2026-10-08T14:30:00Z",
  "step_order": 1
}

Code samples

curl -X POST "$XOS_BASE_URL/approval-decisions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"approval_instance_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","approved":true,"comment":"Within budget."}'
const { data } = await xos.approvalDecisions.create({
    "approval_instance_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "approved": true,
    "comment": "Within budget."
  });
response = xos.approval_decisions.create({"approval_instance_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "approved": True, "comment": "Within budget."})
xos approval-decisions create --data '{"approval_instance_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","approved":true,"comment":"Within budget."}'