Unsubscribe User
vero.unsubscribe_user
ActionEmailconnection required
Calls the Vero API with the connection's credentials.
Globally unsubscribe a user, so no Vero campaign reaches them.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Vero
- Secret shape
- the Vero auth token, or {"auth_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none 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 |
|---|---|---|---|---|---|
id The user's unique identifier in your own product, as Vero's 'id'. | string | No | — | — | 1000 |
email The user's email address; use it when your product has no id for them yet. | string | No | — | email format | ada@example.com |
- At least one of id, email must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email": "ada@example.com",
"id": "1000"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
status The status code Vero echoed in its response body. | number | — |
message Vero's own message, which is 'Success.' when it worked. | string | — |
unsubscribed True when Vero accepted the unsubscribe. | boolean | — |
id The identifier the user was addressed by. | string | — |
email The email the user was addressed by. | string | — |
{
"email": "",
"id": "",
"message": "",
"status": 0,
"unsubscribed": false
}See Unsubscribe User run in a workflow.
In a technical demo we add the Vero connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.