Lead lists preview draft
Count a draft list's matches with its own saved filters and source, nothing spent. Returns the lead_list.preview job; its result has total_entries and availability.
POST/api/v1/lead-lists/{id}/preview
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
No body. Everything the call needs is in the path.
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/lead-lists/{id}/preview" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine lead-lists preview-draft <id>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.
Path
requiredThe record's id.
Request
POST /api/v1/lead-lists/%7Bid%7D/preview
Fill the path first.