v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

LeadList

Patch lead list

Requires one of the following scopes: lead_lists:update, lead_lists:all, all:update, all:all

patch/api/v2/lead-lists/{id}

Path parameters

idstring uuid required

Example:019f94cd-aedc-77bd-80eb-7cba8de72fbe

The ID of the item to update

Request body

has_enrichment_taskboolean nullable

Whether this list runs the enrichment process on every added lead or not

owned_bystring uuid nullable

User ID of the owner of this lead list. Defaults to the user that created the list

namestring

Name of the lead list

Example request

{
  "owned_by": "019f94cd-83b9-7ac6-b8b6-f1e6536b18c1",
  "name": "My Lead List"
}

Response

The updated Lead List

idstring uuid required

Unique identifier for the lead list

organization_idstring uuid required

Organization ID that owns this lead list

has_enrichment_taskboolean nullable

Whether this list runs the enrichment process on every added lead or not

owned_bystring uuid nullable

User ID of the owner of this lead list. Defaults to the user that created the list

namestring required

Name of the lead list

timestamp_createdstring date-time required

Timestamp when the lead list was created

Example response

{
  "id": "019f94cd-83b9-7ac6-b8b6-f1e45dd95f64",
  "organization_id": "019f94cd-83b9-7ac6-b8b6-f1e5911ffe77",
  "owned_by": "019f94cd-83b9-7ac6-b8b6-f1e6536b18c1",
  "name": "My Lead List",
  "timestamp_created": "2026-07-24T15:45:24.409Z"
}