Add Step

Append a step, or insert it at `position` (409 while leads are enrolled). Templates may use `{{lead.first_name}}`, `{{company.name | your team}}`, ... (422 on unknown variables). Returns the sequence with all its steps.

API key access

Needs the sequences:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

POST/api/v1/sequences/{sequence_id}/steps

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Range0 <= value

delay_hours?integer | null

Formatint64

Range0 <= value

subject?string | null

Email only. Template, e.g. 'Quick question, {{lead.first_name}}'

Lengthlength <= 300

body?string | null

Email template, or instructions for call/LinkedIn/manual tasks

Lengthlength <= 20000

ai_brief?string | null

Lengthlength <= 4000

variants?array<Variant> | null

Optional A/B variants (email only)

Itemsitems <= 5

channelStepChannel

Value in"email" | "call" | "linkedin_task" | "manual_task"

position?integer | null

1-based; omit to append at the end

Formatint64

Range1 <= value

Response Body

curl -X POST "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps" \
  -H "X-Workspace-Id: string" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "email"
  }'

curl -X POST "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "channel": "email"  }'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "name": "string",
  "description": "string",
  "status": "draft",
  "settings": {
    "timezone": "America/New_York",
    "send_window_start": "09:00",
    "send_window_end": "17:00",
    "send_days": [
      "mon"
    ],
    "daily_cap": 50,
    "stop_on_reply": true
  },
  "created_by_id": "9377d689-01fb-4abf-8450-3368d2c1924f",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "steps": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
      "position": 0,
      "channel": "email",
      "delay_days": 0,
      "delay_hours": 0,
      "subject": "string",
      "body": "string",
      "ai_brief": "string",
      "variants": [
        {
          "subject": "string",
          "body": "string"
        }
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "enrollment_counts": {
    "property1": 0,
    "property2": 0
  }
}

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body