Create Sequence
convertkit.create_sequence
ActionEmailconnection required
Calls the ConvertKit API with the connection's credentials.
Create an email sequence and set the schedule it sends on.
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
9 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 |
|---|---|---|---|---|---|
name The sequence name. | string | Yes | — | — | Onboarding |
email_address Sending address for the sequence. Kit uses the account default when this is blank. | string | No | — | email format | — |
email_template_id Kit id of the email template the sequence's emails use. | string | No | — | — | — |
send_days Days the sequence may send on, comma-separated: monday through sunday. | string | No | — | — | monday,wednesday,friday |
send_hour Hour of the day the sequence sends at, 0 to 23 in the sequence's time zone. | number | No | — | 0–23 | 9 |
time_zone IANA time zone the send hour is read in. Kit uses the account time zone when this is blank. | string | No | — | — | America/New_York |
active Start the sequence sending straight away. | boolean | No | — | — | — |
repeat Let a subscriber enter the sequence more than once. | boolean | No | — | — | — |
hold Keep subscribers in the sequence after its last email instead of completing them. | boolean | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"name": "Onboarding",
"send_days": "monday,wednesday,friday",
"send_hour": 9,
"time_zone": "America/New_York"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
sequence The sequence record Kit returned, unchanged. | object | — |
id The new sequence's Kit id. | number | — |
name The sequence's name. | string | — |
active True when the sequence is sending. | boolean | — |
{
"active": false,
"id": 0,
"name": "",
"sequence": {}
}See Create 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.