Resource

Flows

The native multi-step workflow engine.

Endpoints · 6

Read · GET

Fetch data — accept query filters, return JSON. Read-only and idempotent.

GET
List flows
/v1/flows
/v1/flows
GET
Retrieve a flow
/v1/flows/{id}
/v1/flows/{id}
GET
List nodes for a flow
/v1/flows/{id}/nodes
/v1/flows/{id}/nodes
GET
Per-node enrollment counts
/v1/flows/{id}/node-counts
/v1/flows/{id}/node-counts
Returns a map of node id → currently-paused-on count. Used by the canvas count chips and the `/runs` step-distribution strip.

Create · POST

Create new records. Send a JSON body; the response is the created resource.

POST
Bulk unenroll contacts
/v1/flows/{id}/unenroll
/v1/flows/{id}/unenroll
Marks the given contacts' active+paused enrollments as terminal with `exit_reason: "manual"`. Capped at 500 per call.

Update · PATCH

Update existing records with a partial diff. Unsent fields are left untouched.

PATCH
Update a flow
/v1/flows/{id}
/v1/flows/{id}
Editing `send_window_*` / `send_days_of_week` / `timezone` walks active and paused enrollments and recomputes `next_run_at` BACKWARDS only — never pushing a contact into the past.

Object shape

The flows object

A flow is a graph of nodes (email, wait, condition, call, whatsapp, task, update_stage, add_to_pool, goal). Enrollments walk the graph one step per outbox tick.

Flows object

{
  "id": "01HZS1Q4XK9R2YQX9F7F1ZQE3T",
  "name": "APAC mid-market — 5-touch",
  "status": "active",
  "enrolled_count": 312,
  "active_count": 247,
  "send_window_start": "09:00",
  "send_window_end": "18:00",
  "send_days_of_week": [
    1,
    2,
    3,
    4,
    5
  ],
  "timezone": "Asia/Kolkata",
  "notify_on_advance": false,
  "created_at": "2026-04-30T12:00:00.000+05:30"
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.