Add Subscriber To Sequence
convertkit.add_subscriber_to_sequence
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Enrol an existing subscriber in a sequence, identified either by their Kit id or by their email address.
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 |
|---|---|---|---|---|---|
sequence_id The Kit id of the sequence to enrol them in. | string | Yes | — | — | 307 |
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",
"sequence_id": "307",
"subscriber_id": "1258"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
subscriber The subscriber record Kit returned, unchanged. | object | — |
id The subscriber's Kit id. | number | — |
email_address The subscriber's email address. | string | — |
state active, cancelled, bounced, complained or inactive. | string | — |
warnings Custom field keys Kit did not recognise and therefore ignored; empty on a fully applied write. | array | — |
{
"email_address": "",
"id": 0,
"state": "",
"subscriber": {},
"warnings": []
}Notes
- The subscriber must already exist and the sequence must be active — Kit refuses an inactive sequence with a 422.
See Add Subscriber To Sequence 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.