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

EntityWhat it is
SequenceThe automation: name, status, trigger type and its steps
SequenceStepAn ordered step (position): send email (SEND_EMAIL) or wait (WAIT)
SequenceEnrollmentA contact's enrollment: its current position, status and next send

A contact can be enrolled in the same sequence only once.

Sequence statuses

StatusMeaning
DRAFTEditable draft. Only in this state can you add, edit or delete steps
ACTIVELive: accepts enrollments and runs steps
PAUSEDPaused: in-flight enrollments move to PAUSED
ARCHIVEDArchived

Endpoints

MethodPathScopeDescription
POST/sequencessequences:writeCreate (starts in DRAFT)
GET/sequencessequences:readList (paginated, status filter)
GET/sequences/:idsequences:readDetail with steps
PATCH/sequences/:idsequences:writeEdit (DRAFT only)
DELETE/sequences/:idsequences:writeDelete (DRAFT only)
POST/sequences/:id/activatesequences:writeDRAFT/PAUSEDACTIVE
POST/sequences/:id/pausesequences:writeACTIVEPAUSED

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"
}
FieldRequiredNotes
nameYesUp to 200 characters
descriptionNoUp to 2000 characters
projectIdNoAttach the sequence to a project
triggerTypeNoMANUAL (default), CONTACT_CREATED, CONTACT_TAGGED, API_EVENT
triggerConfigNoFree-form object with the trigger config

Next step

  1. Add SEND_EMAIL and WAIT steps — see Sequence steps.
  2. Activate it and enroll contacts — see Enrollment & triggers.