Rename, move, disable or hide an entity
ha_update_entityModify a Home Assistant entity's registry settings, including display name, entity_id, area, icon, and disabled/hidden status. Omit fields to leave unchanged; use null to reset.
Instructions
Change an entity's registry entry: its display name, its entity_id, its area, its icon, or whether it is disabled or hidden. Omit a field to leave it alone; pass null for name, area_id or icon to clear it back to the default. Renaming the entity_id does not update automations, scripts or dashboards that use the old one, so check those first (ha_list_automations). Disabling stops the entity being created at all; hiding only keeps it off auto-generated dashboards. Requires HA_ALLOW_CONFIG_WRITE (ha:config).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | e.g. 'mdi:radiator'; null resets it. | |
| name | No | Display name; null resets it to the integration's. | |
| hidden | No | true hides it (by the user); false shows it again. | |
| area_id | No | Area id from ha_list_areas; null removes it. | |
| disabled | No | true disables it (by the user); false enables it again. | |
| entity_id | Yes | The entity to change, e.g. 'sensor.kitchen_temp'. | |
| instance_id | No | Optional: the instance you mean (as listed by vomehome_list_instances). When given, the call is refused if this session is targeting a different home, instead of answering from it. | |
| new_entity_id | No | A new entity_id in the same domain. |