/api/lockbox/{financialAccountId}/rules/{ruleId}/toggle

Flips isActive on one rule and returns the updated rule. No request body.

This is the on/off switch. A disabled rule stays in the table with all its configuration and is simply skipped by the execution engine; its percentage is excluded from the 100% total while it is off.

That makes the direction of the toggle asymmetric:

Disabling always succeeds — it only frees up allocation.
Enabling is validated. If switching the rule on would push the sum of active percentages over 100%, the call returns 400 and the rule stays off. Free up room on another rule first.

Path Params
string
required
int32
required
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json