DocumentationSequences
Sequences
Drip automations built from steps: send and wait, with contact enrollment and their own lifecycle.
A sequence is a drip automation: an ordered list of steps (send an email, wait a while, send another) that the contacts you enroll move through. It requires the sequences:read and sequences:write scopes.
Model
| Entity | What it is |
|---|---|
| Sequence | The automation: name, status, trigger type and its steps |
| SequenceStep | An ordered step (position): send email (SEND_EMAIL) or wait (WAIT) |
| SequenceEnrollment | A contact's enrollment: its current position, status and next send |
A contact can be enrolled in the same sequence only once.
Sequence statuses
| Status | Meaning |
|---|---|
DRAFT | Editable draft. Only in this state can you add, edit or delete steps |
ACTIVE | Live: accepts enrollments and runs steps |
PAUSED | Paused: in-flight enrollments move to PAUSED |
ARCHIVED | Archived |
Endpoints
| Method | Path | Scope | Description |
|---|---|---|---|
POST | /sequences | sequences:write | Create (starts in DRAFT) |
GET | /sequences | sequences:read | List (paginated, status filter) |
GET | /sequences/:id | sequences:read | Detail with steps |
PATCH | /sequences/:id | sequences:write | Edit (DRAFT only) |
DELETE | /sequences/:id | sequences:write | Delete (DRAFT only) |
POST | /sequences/:id/activate | sequences:write | DRAFT/PAUSED → ACTIVE |
POST | /sequences/:id/pause | sequences:write | ACTIVE → PAUSED |
Steps and enrollment have their own pages: Sequence steps and Enrollment & triggers.
Create a sequence
POST /sequences
Authorization: Bearer <apiKey or accessToken>
X-Tenant-Id: {tenantId}
Content-Type: application/json
{
"name": "Onboarding",
"description": "3-email welcome",
"triggerType": "MANUAL"
}
| Field | Required | Notes |
|---|---|---|
name | Yes | Up to 200 characters |
description | No | Up to 2000 characters |
projectId | No | Attach the sequence to a project |
triggerType | No | MANUAL (default), CONTACT_CREATED, CONTACT_TAGGED, API_EVENT |
triggerConfig | No | Free-form object with the trigger config |
Next step
- Add
SEND_EMAILandWAITsteps — see Sequence steps. - Activate it and enroll contacts — see Enrollment & triggers.