Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Sequences

Unenroll Leads

Stop the leads' in-flight enrollments (`stop_reason: unenrolled`). Idempotent.

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}/enrollments/unenroll

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

Header Parameters

X-Workspace-Id?string | null

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

Request Body

lead_idsarray<string>
Items1 <= items <= 1000

Response Body

curl -X POST "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/enrollments/unenroll" \  -H "X-Workspace-Id: string" \  -H "Content-Type: application/json" \  -d '{    "lead_ids": [      "497f6eca-6276-4993-bfeb-53cbbbba6f08"    ]  }'
{
  "stopped": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
      "lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
      "state": "active",
      "current_step": 0,
      "next_run_at": "2019-08-24T14:15:22Z",
      "last_step_at": "2019-08-24T14:15:22Z",
      "stop_reason": "string",
      "enrolled_by_id": "35cb1567-1670-45ae-aef9-039b6c19e8e8",
      "finished_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Set Sequence Mailboxes

Replace the sequence's mailbox pool (RO-271); an empty list sends from every mailbox again. The runner rotates new conversations only within the pool (by rotation weight); follow-ups stay in their thread's mailbox. Every id must be a mailbox of the workspace that isn't disconnected (404). 409 when the sequence is archived.

Update Sequence

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