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

Permanently removes a rule from the lockbox account.

This is a hard delete, not a soft flag — the row is gone and cannot be restored through the API. Use the toggle endpoint when the intent is "stop this for now"; use DELETE when the rule is genuinely retired.

Deleting frees the rule's percentage immediately, so the remaining active rules may leave a larger unallocated remainder in the lockbox from the next deposit onward. Deleting an ACH rule also discards its stored ExternalFinancialAccountId, so re-creating the same destination later will re-register it on first execution.

Historical executions are untouched: LockboxExecutionLog records and the LockboxSplitFundingExecuted activity-log events keep referencing the deleted ruleId. Reports and the activity feed stay intact after a delete.

Path Params
string
required
int32
required
Response
200

Success

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here!