delete_client_group
Delete a local client group and detach its members. Requires confirm=true to complete; without confirmation, the call does nothing.
Instructions
Delete a local group and its memberships. Requires confirm=true.
Mutating operation: removes the local group (local_only) and detaches its members; it does not touch the UniFi controller. Returns success=false unless confirm=true. Recreate with create_client_group if needed.
Args: name: Name of the local group to delete. site: Site to operate on. Defaults to "default". device: Optional device name to target a specific console; omit for default. confirm: Must be True to delete the group; without it the call is a no-op. Defaults to False.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Name of the local group to delete. | |
| site | No | Site to operate on. Defaults to "default". | default |
| device | No | Optional device name to target a specific console; omit for default. | |
| confirm | No | Must be True to delete the group; without it the call is a no-op. Defaults to False. |