Remove Group
ha_config_remove_groupRemove service-based Home Assistant entity groups, including those defined in YAML or created with ha_config_set_group. Not for config-entry-based groups.
Instructions
Remove a service-based Home Assistant entity group via the group.remove service.
When NOT to use: for groups created through ha_config_set_helper(helper_type="group", ...),
use ha_remove_helpers_integrations. Those config-entry-backed groups are not reachable via the
group.remove service.
When to use: removing groups created with ha_config_set_group or defined in YAML
via group: configuration. Config-entry-backed deletion tools cannot find these.
EXAMPLES:
Remove group: ha_config_remove_group("living_room_lights")
Use ha_config_list_groups() to find existing groups.
WARNING:
Removing a group used in automations may cause those automations to fail.
Groups defined in YAML can be removed at runtime but will reappear after restart.
This only removes old-style groups, not platform-specific groups.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| wait | No | Wait for group to be fully removed before returning. Default: True. | |
| object_id | Yes | Group identifier without 'group.' prefix (e.g., 'living_room_lights') |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||