Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Lists

Delete Lead List

Delete the list; its leads stay.

API key access

Needs the leads:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
DELETE/api/v1/lists/{list_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

list_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

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

Response Body

curl -X DELETE "http://localhost:8000/api/v1/lists/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Lead List

A static list (add members afterwards) or a segment (`kind: segment` with `filters`).

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.