delete_group
Delete an account group while preserving members' trading and compliance history; deletion is refused if the group is blocked, P&L-bound, rate-limited, or would change a protected member's currency.
Instructions
Delete an account group. Its member accounts leave the group and keep their trading and compliance history. The delete is refused with loosening_refused, even with force, when the group is blocked, when it carries a group-scoped Spot Funds P&L bound, or while any rate-limit barrier is configured; it is refused with currency_change_blocked, even with force, when leaving would change the effective currency of a member carrying protected state. The group's trading access grants are deleted with it; its former members keep only their own. The default group cannot be deleted. Mutates Officer control-plane config; protected and disabled by default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Does not change whether the delete succeeds: a group carrying a group-scoped Spot Funds P&L bound, the only rows force would delete with it, is refused with loosening_refused with or without force, and a delete that would change the effective currency of a member carrying protected state is refused even with force | |
| group | Yes | Group code |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | Does not change whether the delete succeeds: a group carrying a group-scoped Spot Funds P&L bound, the only rows force would delete with it, is refused with loosening_refused with or without force, and a delete that would change the effective currency of a member carrying protected state is refused even with force | |
| group | Yes | Group code |