Update Subscriber
convertkit.update_subscriber
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Update a subscriber's email address, first name or custom field values.
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
4 fields, 2 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 |
email_address The subscriber's email address. Kit requires it on every update, so pass the current address when you are only changing something else. | string | Yes | — | email format | alice@example.com |
first_name New first name for the subscriber. | string | No | — | — | — |
fields Custom field values to set, as an object keyed by each custom field's key ('last_name', not 'Last Name'). Kit ignores keys it does not know and lists them in 'warnings'. | object | No | — | — | {"category":"newsletter"} |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"email_address": "alice@example.com",
"fields": {
"category": "newsletter"
},
"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
- Custom field keys Kit does not recognise are ignored and listed in the 'warnings' output rather than failing the call.
See Update 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.