Delete a lead list
Delete a list. The leads stay unless delete_leads is true; a lead that also sits in another list always stays; companies are never touched.
DELETE/api/v1/lead-lists/{id}
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
delete_leads | body, boolean | Also delete the leads that belong only to this list. |
Example
curl
curl -X DELETE "https://crm.ashwanth.dev/api/v1/lead-lists/{id}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"delete_leads": false
}'CLI
sales-engine lead-lists delete <id>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.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
DELETE /api/v1/lead-lists/%7Bid%7D
Fill the path first.