Delete List
iterable.delete_list
ActionEmailconnection required
Calls the Iterable API with the connection's credentials.
Delete a static list by its id.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Iterable
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- region, 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 |
|---|---|---|---|---|---|
list_id The id of the list to delete. | integer | Yes | — | ≥ 1 | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
code Iterable's response code, 'Success' when the call was accepted. | string | — |
msg The human-readable message Iterable returned. | string | — |
params Any extra detail Iterable attached to the response. | object | — |
list_id The list that was deleted. | number | — |
{
"code": "",
"list_id": 0,
"msg": "",
"params": {}
}See Delete List run in a workflow.
In a technical demo we add the Iterable connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.