Lists
Enroll Lead List
Enroll the list's leads in a campaign (at most 1000; 422 `list_too_large`, `empty_list`). The same checks as enrolling leads one by one apply: leads already in the campaign are skipped, and consent, suppressions and sending limits are checked before anything is sent. Enrolling doesn't start the campaign.
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/lists/{list_id}/enrollAuthorizationBearer <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
list_idstring
Format
uuidHeader Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
sequence_idstring
Format
uuidResponse Body
curl -X POST "http://localhost:8000/api/v1/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08/enroll" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{ "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f" }'{
"enrolled": [
{
"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"
}
],
"skipped": [
{
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"reason": "not_found"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}