Unsubscribe
sendy.unsubscribe
ActionEmailconnection required
Calls the Sendy API with the connection's credentials.
Unsubscribe an address from one Sendy list.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Sendy
- Secret shape
- the Sendy API key, or {"api_key": "…"}
- Config it needs
- base_url, list_id, brand_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 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 |
|---|---|---|---|---|---|
email The subscriber's email address. | string | Yes | — | email format | ada@example.com |
list_id The Sendy list to act on; overrides the list set on the connection. | string | No | — | — | ZjcRlkKUNPUJU892heoY6Q |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email": "ada@example.com",
"list_id": "ZjcRlkKUNPUJU892heoY6Q"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
unsubscribed True when Sendy unsubscribed the address. | boolean | — |
status Sendy's own answer, which is 'true' on success. | string | — |
email The address that was unsubscribed. | string | — |
list_id The list the address was unsubscribed from. | string | — |
{
"email": "",
"list_id": "",
"status": "",
"unsubscribed": false
}See Unsubscribe run in a workflow.
In a technical demo we add the Sendy connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.