> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Create sequence

> Creates an empty automated email sequence.

`kit.createSequence` creates an empty automated email sequence.

```ts automations/create-sequence.automation.ts theme={null}
import { automation, markSignificant } from "automate.ax"
import { kit } from "automate.ax/kit"

export default automation("Create sequence", () => {
  markSignificant(
    kit.createSequence({
      name: "Welcome series",
    }),
  )
})
```

## Input

Pass these fields:

| Field                      | Type       | Required | Description                                                                                                                                 |
| -------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`                     | `string`   | No       | The name of the sequence.                                                                                                                   |
| `emailAddress`             | `string`   | No       | The sending email address to use. Uses the account's sending email address if not provided.                                                 |
| `emailTemplateId`          | `integer`  | No       | Id of the email template to use.                                                                                                            |
| `sendDays`                 | `string[]` | No       | The days of the week to send the sequence on. Must be one of: `monday`, `tuesday`, `wednesday`, `thursday`, `friday`, `saturday`, `sunday`. |
| `sendHour`                 | `integer`  | No       | The hour of the day to send the sequence at. Must be an integer between 0 and 23.                                                           |
| `timeZone`                 | `string`   | No       | The timezone to use for the sequence. Must be a valid IANA timezone string.                                                                 |
| `active`                   | `boolean`  | No       | `true` to activate the sequence, `false` to deactivate it.                                                                                  |
| `repeat`                   | `boolean`  | No       | When `true`, subscribers can restart the sequence multiple times.                                                                           |
| `hold`                     | `boolean`  | No       | When `true`, subscribers added via Visual Automations stay in the sequence after receiving the last email.                                  |
| `excludeSubscriberSources` | `object[]` | No       | The subscriber sources to exclude from the sequence.                                                                                        |

## Output

Returns an object with these fields:

| Field      | Type     | Required | Description |
| ---------- | -------- | -------- | ----------- |
| `sequence` | `object` | Yes      | —           |

Kit rate limits OAuth connections to 600 requests per 60 seconds and V4 API keys to 120 requests per 60 seconds. Automate.ax honors provider retry timing for rate-limit and temporary bulk-capacity responses.
