Update Rule
Partially update a rule. Custom rules accept every configuration field. Library (PRESET) rules accept only mode - use it to activate, disable, or switch a preset to TEST; any other field returns 400.
Authorizations
Path Parameters
The rule's uuid from list or create.
Body
Partial update. Custom rules accept every field; library (PRESET) rules accept only mode - anything else returns 400.
Rule name. Unique per application among non-deleted rules; duplicates return 400.
Risk theme used for grouping and reporting, e.g. finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce.
ACTIVE evaluates live. TEST evaluates and records rule runs but never touches score or status - the recommended starting mode. DISABLED is skipped.
ACTIVE, DISABLED, TEST Whether every condition must match (ALL) or at least one (ANY). Ignored when conditions use group_index.
ALL, ANY Which transactions the rule applies to. Only these three keys are accepted.
One rule action. A rule can carry several; all are applied together when it matches. Rules in TEST mode record what they would have done without applying any action.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Free-form metadata stored on the rule.
Response
The updated rule.
Rule name. Unique per application among non-deleted rules; duplicates return 400.
Risk theme used for grouping and reporting, e.g. finance, aml_ctf, anomaly_detection, fatf, device_intelligence, crypto_monitoring, travel_rule, responsible_gaming, e_commerce.
ACTIVE evaluates live. TEST evaluates and records rule runs but never touches score or status - the recommended starting mode. DISABLED is skipped.
ACTIVE, DISABLED, TEST Whether every condition must match (ALL) or at least one (ANY). Ignored when conditions use group_index.
ALL, ANY Which transactions the rule applies to. Only these three keys are accepted.
One rule action. A rule can carry several; all are applied together when it matches. Rules in TEST mode record what they would have done without applying any action.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Free-form metadata stored on the rule.
Informational severity carried by library rules; not settable on custom rules.
UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL PRESET rules come from the library (install/uninstall, mode-only edits); CUSTOM rules are fully yours.
PRESET, CUSTOM Stable library identifier; null for custom rules.
How many transactions matched this rule.