Skip to main content
PUT
Update rule on draft policy

Authorizations

X-API-Key
string
header
required

Headers

API-Version
enum<string>
default:v1

API version (defaults to the latest supported version if omitted).

Available options:
v1

Path Parameters

id
string<uuid>
required

Policy ID

rule_id
string<uuid>
required

Rule ID

Body

application/json
action_config
string[]

Type-specific configuration for the action; shape must match action_type when provided.

action_type
string

New action type; when provided, must match the action_config shape. Omit to leave unchanged.

Example:

"require_approval"

conditions
object[]

Replacement set of conditions; omit to leave conditions unchanged.

description
string

New description for the rule; omit to leave unchanged.

Maximum string length: 1000
name
string

New name for the rule (2–255 characters); omit to leave unchanged.

Required string length: 2 - 255
Example:

"Block large transfers"

order
integer

New position of the rule in the policy's evaluation order; omit to leave unchanged.

Response

Success

action_config
any

Type-specific configuration for the action; shape depends on action_type.

action_type
string

Action taken when the rule matches: allow, block, require_approval, alert, or delay.

Example:

"require_approval"

conditions
object[]

Conditions that must all match for the rule to apply.

created_at
string<date-time>

Timestamp when the rule was created.

Example:

"2026-05-16T10:30:00Z"

description
string

Optional free-text summary of the rule's intent.

id
string

Unique identifier of the rule.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

name
string

Human-readable name of the rule.

Example:

"Block large transfers"

object
string

Object type discriminator; always "rule".

Example:

"rule"

order
integer

Position of the rule in the policy's first-match-wins evaluation order.

Example:

1

priority
integer

Evaluation priority of the rule.

Example:

50

updated_at
string<date-time>

Timestamp when the rule was last updated.

Example:

"2026-05-16T10:30:00Z"