Skip to main content

Overview

A lead list is a reusable collection of leads in your workspace. Lists are useful when the same audience needs to be enriched, enrolled, or reported on more than once. A lead can belong to more than one list. The Lead Lists API supports:
  • Creating and maintaining named lists
  • Adding leads directly to a list
  • Listing the leads in a list
  • Enriching every lead in a list asynchronously
  • Deleting a list without deleting the underlying leads

Create a list

Save the returned id; it is used by the remaining list endpoints.

List and update lists

Updating a list changes list metadata only. It does not change the leads already assigned to it.

Add and list leads

Create a lead inside a list with the list-specific endpoint:
List the leads currently in a list:
Use the general Leads guide when you need to update, enrich, or inspect an individual lead after it has been added.

Enrich a list

Enrichment runs in the background so large lists do not block the request:
The response includes a job_id. Poll Jobs until the job reaches completed, failed, or cancelled.
Enrichment can update lead fields and consume workspace enrichment credits. Start with a small list when validating a new enrichment workflow.

Use a list in a campaign

Campaign enrollment accepts a list ID for bulk enrollment:
See Campaigns for individual-lead enrollment, preflight checks, and launch controls.

Delete a list

Deleting a list removes the grouping, not the leads inside it. Delete individual leads through the Leads API when that is the intended operation.