Rules

Add a spend rule

post/api/rules

Request

  • Base URL: https://sipi.bot
  • URL: https://sipi.bot/api/rules
  • Auth: HTTP bearer

Request body

rule_type'per_transaction' | 'daily_total' | 'velocity' | 'merchant_block' | 'merchant_allow' | 'category_limit' | 'time_window' | 'approval_threshold' required
paramsobject

Rule-type-specific parameters.

action'APPROVED' | 'BLOCKED' | 'FLAGGED'

APPROVED = pass all rules. BLOCKED = violates a hard rule, no money moves. FLAGGED = allowed but crosses an approval threshold, routed to the human queue.

priorityinteger
labelstring

Example request

{
  "params": {
    "max_amount": 500
  }
}

Response

Created rule.

idstring
rule_type'per_transaction' | 'daily_total' | 'velocity' | 'merchant_block' | 'merchant_allow' | 'category_limit' | 'time_window' | 'approval_threshold'

The rule check to apply.

paramsobject

Rule-type-specific parameters.

action'APPROVED' | 'BLOCKED' | 'FLAGGED'

APPROVED = pass all rules. BLOCKED = violates a hard rule, no money moves. FLAGGED = allowed but crosses an approval threshold, routed to the human queue.

priorityinteger

Higher priority rules are evaluated first. First BLOCK wins.

enabledboolean
labelstring

Optional human label used as the reason when the rule trips.

agent_idstring nullable

Scope this rule to a specific agent. null = global.

Example response

{
  "id": "r_per_transaction_500",
  "params": {
    "max_amount": 500
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.