Skip to main content
POST
Create a rule

Authorizations

Authorization
string
header
required

API key (pk_test_* or pk_live_), JWT session, agent token (agent_), Ed25519 session (sess_), or portal token (portal_).

Body

application/json
name
string
required
trigger_type
enum<string>
required
Available options:
balance_threshold,
time_based,
event_based,
manual,
transaction_count
trigger_config
object
required
action_type
enum<string>
required
Available options:
settle_to_bank,
settle_to_account,
settle_to_wallet,
hold,
notify
action_config
object
required
enabled
boolean
required
priority
integer
required
wallet_id
string<uuid> | null

Response

Created

data
object
required