Skip to main content
POST
Import matching professional leads into an existing smart list.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Lead import criteria plus the destination smart list

companyId
string
required

Company ID for access and any applicable data-credit charges

listId
string
required

Destination smart list id. Must already exist.

filters
object
required

Professional/company filters from lead_field_options(describe=true). Accepts catalog camelCase fields (title, seniority, department, company, companyDomain, industry, employeeRange, country, city, education, numeric min/max fields, exclusions). Country values are two-letter codes. Use lead_field_options to discover supported fields.

importAll
boolean

true = import every matching contact. Defaults to true only when no count is given; pass count to import a slice.

count
integer

Max contacts to import. Required when importAll is false. The import stops after this many records.

audienceName
string

Name for the import. Default "Leads".

Response

The import was queued; poll taskId for progress

The queued background import

taskId
string

Background task id for the running import.

listId
string

The destination smart list.

status
string

Always "background" — the import runs asynchronously.

message
string

Human-readable status message