Update Lead List

API key access

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

PATCH/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).

Request Body

name?string | null

Length1 <= length <= 120

description?string | null

Lengthlength <= 500

filters?SegmentFilters | null

Response Body

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

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

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "kind": "static",
  "filters": {
    "status": [
      "string"
    ],
    "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
    "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
    "q": "string",
    "title": "string",
    "industry": "string",
    "country": "st",
    "replied": true
  },
  "member_count": 0,
  "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200

422