Create a sequence
create_sequenceCreate and configure an email sequence with send schedules, activation status, and subscriber exclusions. Requires confirmation for delivery or audience changes.
Instructions
Create a sequence. May affect delivery, audience membership, published data or irreversible state. Requires confirm=true.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hold | No | When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email. | |
| name | No | The name of the sequence. | |
| active | No | `true` to activate the sequence, `false` to deactivate it. | |
| repeat | No | When `true`, subscribers can restart the sequence multiple times. | |
| account | No | Named private account from KIT_ACCOUNTS. Defaults to KIT_DEFAULT_ACCOUNT or the first configured account. | |
| confirm | No | Must be true for audience/delivery changes, publishing, destructive operations and signing-secret changes. Use only for an action requested by the user. | |
| payload | No | Complete JSON body instead of individual body flags. Supports nullable fields and nested bulk structures. Cannot be combined with body flags or payload_file. | |
| send_days | No | The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`. | |
| send_hour | No | The hour of the day to send the sequence at. Must be an integer between 0 and 23. | |
| time_zone | No | The timezone to use for the sequence. Must be a valid IANA timezone string. | |
| payload_file | No | Local JSON request body file, at most 5 MB. Contents are validated before the API call and are never logged. | |
| email_address | No | The sending email address to use. Uses the account's sending email address if not provided. | |
| email_template_id | No | Id of the email template to use. | |
| exclude_subscriber_sources | No | The subscriber sources to exclude from the sequence. |