update_rule
Edit an existing trading rule by updating only the fields you specify—retune trigger thresholds, change action, rename, reprioritize, or adjust live mode deployment.
Instructions
Edit an existing systematic trading rule. Only fields you pass are updated; omit a field to leave it untouched. Use to retune a trigger threshold, change the action, rename, reprioritize, or flip activation. For just toggling active/inactive, prefer toggle_rule (clearer intent). live_mode controls broker deployment: null = paper-only, 'observe' = log live signals without trading, 'auto' = execute via connected broker. Live deployment requires a connected broker (see platform UI).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | New rule name | |
| action | No | New action spec (same shape as create_rule) | |
| rule_id | Yes | Rule UUID | |
| trigger | No | New trigger spec (same shape as create_rule) | |
| priority | No | Execution priority (lower runs first when multiple rules fire) | |
| is_active | No | Activate / deactivate | |
| live_mode | No | Broker deployment: null / 'observe' / 'auto' | |
| description | No | New description | |
| portfolio_id | Yes | Portfolio UUID |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |