Skip to main content
POST
Archive a business policy
An archived policy is never evaluated again, can no longer be changed, and leaves the policy list unless you filter by status=ARCHIVED; reading it by ID still works. Approval requests it already opened are not affected — they keep the approvers and settings they were opened with. To stop a policy for a while instead, update it to status: "DISABLED". The request has no body. The response is the archived policy; its approvers come without name. Only organization admins can archive policies.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization the policy belongs to.

Format: UUID

businessPolicyId
string<uuid>
required

ID of the business policy.

Format: UUID

Response

Successful response

A business policy of the organization.

id
string<uuid>
required

ID of the business policy.

Example:

"3f1c9a52-7d4e-4b8a-9c21-5e6f0a8b2d47"

realmId
string<uuid>
required

ID of the realm the policy belongs to.

Example:

"f495ff0c-ab54-4f99-8e92-ca8682e4de9b"

organizationId
string<uuid>
required

ID of the organization the policy belongs to.

Example:

"c4bd3f21-dfbd-44e8-8055-68ba15bed410"

context
enum<string>
required

What the policy governs. PAYMENT: a Pix payment, a boleto payment or a wallet transfer request, before it is paid. SPEND_REVIEW: the review of a transaction that already happened. TRAVEL: no travel flow evaluates policies yet.

Available options:
PAYMENT,
SPEND_REVIEW,
TRAVEL
Example:

"PAYMENT"

name
string
required

Name of the policy, shown to approvers.

Example:

"Payments over R$ 5,000"

order
number
required

Evaluation order: active policies of the same context are tried from the lowest order up — the oldest first on a tie — and the first match decides.

Example:

10

status
enum<string>
required

ACTIVE: evaluated. DISABLED: kept, never evaluated. ARCHIVED: archived for good — never evaluated, can no longer be changed.

Available options:
ACTIVE,
DISABLED,
ARCHIVED
Example:

"ARCHIVED"

conditions
object
required

When the policy matches.

actions
object
required

What the policy does when it matches.

createdAt
string<date-time>
required

When the policy was created.

Example:

"2026-10-14T13:45:12.000Z"

updatedAt
string<date-time>
required

When the policy was last changed.

Example:

"2026-11-03T18:02:40.000Z"

description
string

What the policy does, in plain words. Absent when none was written.

Example:

"Pagamentos acima de R$ 5.000,00 precisam da aprovação do time financeiro."