Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Sequences

Update Step

Partial update; a delay change reschedules enrollments waiting on this step.

API key access

Needs the sequences:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
PATCH/api/v1/sequences/{sequence_id}/steps/{step_id}

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

Path Parameters

sequence_idstring
Formatuuid
step_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Request Body

delay_days?integer | null
Formatint64
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
channel?StepChannel | null

Response Body

curl -X PATCH "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/steps/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Update Sequence

Partial update. A settings change reschedules active enrollments. 409 if archived.

Create Signal Rule

Add a trigger rule (admin+): when a new signal matches its kinds and keywords, `notify` (flag the signal and send a `signal.triggered` webhook) or `enroll` up to `max_leads` of the company's leads into an active sequence. Enrolling checks reachability, consent and suppressions per lead; contact pressure, calling windows and send caps apply when steps run. 409 over `SIGNALS_MAX_RULES`.