Sequences API

List Sequences


GET /api/v1/sequences

Scope: sequences:read

Returns all active sequences available for enrollment.

Response


{
  "sequences": [
    {
      "id": "uuid",
      "name": "Assessment Follow-Up",
      "description": "3-step follow-up after AI assessment",
      "status": "active",
      "step_count": 3,
      "created_at": "2026-03-20T10:00:00Z"
    }
  ]
}

Enroll Contact in Sequence


POST /api/v1/sequences/enroll

Scope: sequences:write

Enrolls a contact in a sequence. The contact can be identified by contact_id or contact_email.

Request Body


{
  "sequence_id": "uuid-of-sequence",
  "contact_id": "uuid-of-contact"
}

Or by email:


{
  "sequence_id": "uuid-of-sequence",
  "contact_email": "john@acme.com"
}

sequence_id is required. One of contact_id or contact_email is required.

Response (201)


{
  "enrollment": {
    "id": "uuid",
    "sequence_id": "uuid",
    "contact_id": "uuid",
    "status": "active"
  },
  "sequence_name": "Assessment Follow-Up"
}

Notes

If the contact is already enrolled in the sequence, the enrollment is updated (upserted)
The contact must exist before enrollment — create it first via POST /contacts
Sequence steps execute according to their configured delays

Sequence Object Fields

When listing or retrieving sequences, the following fields control builder and flow behavior:

Field	Type	Default	Description
`builder_mode`	`"linear"` \| `"visual"`	`"linear"`	`linear` uses the classic ordered step list. `visual` uses the drag-and-drop canvas with nodes and edges.
`flow_type`	`"sequence"` \| `"automation"`	`"sequence"`	`sequence` is a contact-enrollment flow. `automation` is an event-driven flow triggered by webhooks, schedules, or CRM events.

These fields are included in all sequence responses (list and detail).

Example Response with Builder Fields


{
  "sequences": [
    {
      "id": "uuid",
      "name": "Onboarding Flow",
      "description": "Visual onboarding sequence",
      "status": "active",
      "step_count": 5,
      "builder_mode": "visual",
      "flow_type": "sequence",
      "created_at": "2026-03-28T10:00:00Z"
    },
    {
      "id": "uuid",
      "name": "Payment Received Automation",
      "description": "Triggers on Stripe webhook",
      "status": "active",
      "step_count": 4,
      "builder_mode": "visual",
      "flow_type": "automation",
      "created_at": "2026-03-29T08:00:00Z"
    }
  ]
}

Visual Builder API — Canvas, node, edge, and AI generation endpoints for visual sequences
Automations API — Webhook triggers, automation runs, node configuration, and template variables