Remove Tag From Subscriber
convertkit.remove_tag_from_subscriber
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Remove a tag from a subscriber, identified either by their Kit id or by their email address. The subscriber itself is kept.
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
3 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 |
|---|---|---|---|---|---|
tag_id The Kit id of the tag to remove. | string | Yes | — | — | 218 |
subscriber_id The subscriber's Kit id. Give this or 'email_address'. | string | No | — | — | 1258 |
email_address The subscriber's email address, when you do not hold their Kit id. | string | No | — | email format | alice@example.com |
- At least one of subscriber_id, email_address must be set.
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email_address": "alice@example.com",
"subscriber_id": "1258",
"tag_id": "218"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
removed True once Kit has removed the tag. | boolean | — |
tag_id The tag that was removed. | string | — |
subscriber_id The subscriber id used, if one was given. | string | — |
email_address The email address used, if one was given. | string | — |
{
"email_address": "",
"removed": false,
"subscriber_id": "",
"tag_id": ""
}See Remove Tag From 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.