Delete State
home_assistant.delete_state
ActionBusiness appsconnection required
Calls the Home Assistant API with the connection's credentials.
Remove an entity from the state machine.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Home Assistant
- Secret shape
- the long-lived access token, or {"access_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
entity_id The entity to remove, as '<domain>.<object_id>'. | string | Yes | — | — | sensor.mantle_last_run |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"entity_id": "sensor.mantle_last_run"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
entity_id The entity that was removed. | string | — |
deleted True — Home Assistant answers 404 otherwise. | boolean | — |
message Home Assistant's own confirmation message. | string | — |
{
"deleted": false,
"entity_id": "",
"message": ""
}Notes
- An entity backed by an integration is recreated on the next update; this removes the state object, not the integration.
- Home Assistant requires an admin token for this call; a non-admin long-lived token fails with 401 even though the connection tests green.
Related Home Assistant nodes
See Delete State run in a workflow.
In a technical demo we add the Home Assistant connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.