Unsubscribe Subscriber
convertkit.unsubscribe_subscriber
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Move a subscriber to the cancelled state, keeping their record, history and tags in the account.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ConvertKit
- Secret shape
- the v4 API key, or {"api_key": "…"}, or {"access_token": "…"} for OAuth
- 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 |
|---|---|---|---|---|---|
subscriber_id The subscriber's Kit id. | string | Yes | — | — | 1258 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"subscriber_id": "1258"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
unsubscribed True once Kit has cancelled the subscriber. | boolean | — |
subscriber_id The subscriber id that was cancelled. | string | — |
{
"subscriber_id": "",
"unsubscribed": false
}Notes
- Unsubscribing revokes consent: resubscribing that address needs the person's explicit permission again.
See Unsubscribe Subscriber run in a workflow.
In a technical demo we add the ConvertKit connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.