# Sequence

URL: /business/nouns/sequence · Id: `noun:sequence`

> A Sequence is a timed series of steps run for one Contact at a time: send a Message, wait, branch, or stop.

A Sequence is a timed series of steps run for one [Contact](/business/nouns/contact) at a time: send a [Message](/business/nouns/message), wait, branch, or stop.

## Properties
| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `steps` | `json` | Yes | The steps, waits, and branches. |
| `exitOn` | `string` | No | The Events that end it from any step, such as a reply or a purchase. |

## Object
```json
{
  "$id": "https://api.sb/patentpad.com/sequences/sequence_1",
  "$type": "Sequence",
  "steps": {},
  "exitOn": "Example exit on"
}
```

## Relationships
- <a id="rel-enrollments"></a>A Sequence **has** many [Enrollments](/business/nouns/enrollment): the Sequence whose steps this [Enrollment](/business/nouns/enrollment) walks, one step at a time. `enrollments`, inverse [`follows`](/business/nouns/enrollment#rel-follows).
- <a id="rel-enrolls"></a>A Sequence **enrolls** many [Contacts](/business/nouns/contact): a Sequence runs for an enrolled [Contact](/business/nouns/contact) until a reply, a purchase, or another exit [Event](/business/nouns/event) ends it. `enrolls`, inverse [`enrolledIn`](/business/nouns/contact#rel-enrolled-in).
- <a id="rel-nurtures"></a>A Sequence **nurtures** many [Funnels](/business/nouns/funnel): a [Funnel](/business/nouns/funnel) follows up with each new [Lead](/business/nouns/lead) through Sequences after the opt-in. `nurtures`, inverse [`nurturesWith`](/business/nouns/funnel#rel-nurtures-with).
- <a id="rel-schedules"></a>A Sequence **schedules** many [Messages](/business/nouns/message): a Sequence sends [Messages](/business/nouns/message), each at its own step and wait. `schedules`, inverse [`scheduledBy`](/business/nouns/message#rel-scheduled-by).

## Verbs
| Verb | Description | Subject | Event | Class |
| --- | --- | --- | --- | --- |
| <a id="create"></a>[Sequence.create](/business/nouns/sequence/create) | Creates a Sequence. Inherited from [Noun](/business/nouns/noun). | None. | `Sequence.created` | Two-way: `try`, `send`, `do` |
| <a id="get"></a>[Sequence.get](/business/nouns/sequence/get) | Returns one Sequence by id. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="list"></a>[Sequence.list](/business/nouns/sequence/list) | Returns Sequences, newest first, one page at a time. Inherited from [Noun](/business/nouns/noun). | None. | None. | Read: `try`, `do` |
| <a id="update"></a>[Sequence.update](/business/nouns/sequence/update) | Changes the given properties of a Sequence. Inherited from [Noun](/business/nouns/noun). | None. | `Sequence.updated` | Two-way: `try`, `send`, `do` |
| <a id="delete"></a>[Sequence.delete](/business/nouns/sequence/delete) | Deletes a Sequence; its history is kept. Inherited from [Noun](/business/nouns/noun). | None. | `Sequence.deleted` | One-way: `send`, `do` |

## Permissions
Which Access level may call each Verb. One-way Verbs wait their delay window.

| Operation | `owner` | `admin` | `member` | `viewer` |
| --- | --- | --- | --- | --- |
| `Sequence.create` | Yes | Yes | Yes | No |
| `Sequence.get` | Yes | Yes | Yes | Yes |
| `Sequence.list` | Yes | Yes | Yes | Yes |
| `Sequence.update` | Yes | Yes | Yes | No |
| `Sequence.delete` | Yes | Yes | Yes | No |

## Call it

**Ask**

```text
Add a sequence to ShiftNote.
```

**API**

```bash
curl -X POST https://api.sb/shiftnote.app/sequences \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'
```

```json
{
  "api": "https://api.sb/shiftnote.app",
  "sequence": {
    "$id": "https://api.sb/shiftnote.app/sequences/sequence_1",
    "$type": "Sequence",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/shiftnote.app/actions/action_1",
    "operation": "Sequence.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/shiftnote.app/actions/action_1"
  }
}
```

**SDK**

```ts
import { $ } from 'startup-builder'

const sequence = await $.Sequence.create({ steps: {} })
```

**CLI**

```bash
npx startup-builder do Sequence.create --json '{"steps":{}}'
```

**MCP**

```json
{
  "name": "do",
  "arguments": {
    "code": "return await $.Sequence.create({ steps: {} })"
  }
}
```

## Example
A trial Sequence sends a welcome Message, waits 3 days, then sends a setup tip only if the Contact has made no API call.