Delete a counterparty rule
delete_counterparty_ruleRemoves a counterparty rule. Future events from this counterparty stop auto-classifying and fall back to the static vendor map or the review queue. Already-booked events are unchanged. Writes an audit entry capturing the deleted rule. actor_id is optional — it defaults to the organisation entity, and if provided must belong to this org.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| org_id | No | Optional. Defaults to the organisation the authenticated API key is bound to, so you normally omit it and never need to ask the user for their organisation UUID. If provided, it must match the key’s org or the request is rejected. | 0e91146d-511c-469f-bdee-5c867b26ae0d |
| reason | Yes | Why the rule is being removed. Stored verbatim in the audit trail. | |
| rule_id | Yes | The rule_id from list_counterparty_rules. | |
| actor_id | No | Optional. Defaults to the organisation entity (correct for an org-scoped key). If provided, it must be an entity belonging to this organisation — arbitrary UUIDs are rejected, so the audit trail cannot be attributed to someone else. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| deleted | Yes | ||
| rule_id | Yes | ||
| counterparty_key | Yes |