Book a demo

Add Subscriber To Form

convertkit.add_subscriber_to_form
ActionEmailconnection required

Calls the ConvertKit API with the connection's credentials.

Subscribe an existing subscriber to a form, identified either by their Kit id or by their email address.

Ask about ConvertKitAll ConvertKit nodesProvider API docs ↗

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, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
form_id
The Kit id of the form to add them to.
stringYes——287
subscriber_id
The subscriber's Kit id. Give this or 'email_address'.
stringNo——1258
email_address
The subscriber's email address, when you do not hold their Kit id.
stringNo—email formatalice@example.com
referrer
Source URL Kit records for this subscription; its utm_ query parameters come back parsed on the subscriber. Kit publishes this as required when adding by 'subscriber_id', so set it on that path to avoid a 422.
stringNo—url formathttps://example.com/pricing?utm_source=newsletter
  • 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",
  "form_id": "287",
  "referrer": "https://example.com/pricing?utm_source=newsletter",
  "subscriber_id": "1258"
}

Output

One shape.

result

FieldTypeExample
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; this node does not create one.
  • Kit's reference marks 'referrer' required on the add-by-subscriber-id form endpoint and optional on the add-by-email one; set it whenever you pass 'subscriber_id'.

Related ConvertKit nodes

See Add Subscriber To Form 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.

Book a technical demoTalk to sales