Docs
Esc

Suggested

QuickstartGet started
Webhooks and signaturesMessaging
Create a messagemessages.create · POST /v1/accounts/{AC}/messages
RATE_LIMITED429 · Rate limit exceeded.
message.deliveredMessage resource
Contents

API reference

Approvals

API reference descriptions are provided in English to preserve the exact published contract.

List approval requests

GET/v1/accounts/{AC}/approvals

approvals.listSDK operation getV1AccountsByAcApprovals

Required scope: approvals:read.Paginated

Parameters

  • limitinteger (1–100)query
  • cursorstring (max 2048 chars)query

Create an approval request

POST/v1/accounts/{AC}/approvals

approvals.createSDK operation postV1AccountsByAcApprovals

Required scope: approvals:request.Idempotency-Key required

Request body

  • actionstring (pattern ^[A-Z][A-Z0-9_]*$, max 128 chars)Required
  • reasonstring (max 2000 chars)Required
  • requiredApproverRolestring (max 64 chars)Required
  • resourceRefstring (max 256 chars)Required
  • caseRefstring (max 128 chars)
  • expiresAtstring (date-time)
  • riskClassenum

    STANDARDHIGHCRITICAL

Approve an approval request

POST/v1/accounts/{AC}/approvals/{AP}/approve

approvals.approveSDK operation postV1AccountsByAcApprovalsByApApprove

Required scope: approvals:decide.Idempotency-Key required

Parameters

  • APstring (AP… SID)Required

Request body

  • decisionNotestring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)

Reject an approval request

POST/v1/accounts/{AC}/approvals/{AP}/reject

approvals.rejectSDK operation postV1AccountsByAcApprovalsByApReject

Required scope: approvals:decide.Idempotency-Key required

Parameters

  • APstring (AP… SID)Required

Request body

  • decisionNotestring (max 2000 chars)Required
  • stepUpTokenstring (max 256 chars)

Withdraw an approval request

POST/v1/accounts/{AC}/approvals/{AP}/withdraw

approvals.withdrawSDK operation postV1AccountsByAcApprovalsByApWithdraw

Required scope: approvals:request.Idempotency-Key required

Parameters

  • APstring (AP… SID)Required