Source a lead list
Source a new lead list from Apollo or MoltSets with the ICP defaults, verification and enrichment. Leads already in the CRM are skipped and the search pages on until requested_count new leads are in or the matches run out. Returns the list and its build job.
POST/api/v1/lead-lists
Parameters
Body
A JSON object, required. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
namerequired | body | List name. |
requested_count | body, integer | How many leads to source, 1 to 1000. |
paramsrequired | body, object | Search: {mode: form | natural_language, description, filters: {titles, seniorities, industries, employee_ranges, person_locations, org_locations, domains, keywords}, use_icp_defaults, icp_profile_id, options: {verify, verify_mode, profile_tier, posts, research, phone}}. phone asks Apollo for a mobile number per lead (an extra credit each, arrives asynchronously). |
draft | body, boolean | Save the list as a draft without searching; open it in Lead search to preview and start it. |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/lead-lists" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"params": {},
"requested_count": 0,
"draft": false
}'CLI
sales-engine lead-lists create --name "..." --params '{}'The JSON above lists every documented field with a typed placeholder; send only the ones you mean.
Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/lead-lists