Delete Leads

Delete multiple leads that match a filter.

When to use. Remove many leads in one request. To delete a single known lead, use DELETE /leads/{id}.

Request body. A filter object selecting which leads to delete. Each key is a lead field: a scalar value matches by equality and an array matches any of the listed values. An empty body is rejected with 400.

Returns. { "removedLeads": [ ... ] } listing the leads that were deleted.

Example. PUT /api/leads/mass-delete with body { "id": [ 101, 102 ] }

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter object selecting which leads to delete. Each key is a lead field; a scalar matches by equality and an array matches with IN (...).

id
array of integers

Lead IDs to delete.

id
first_name
array of strings

Match by first name(s).

first_name
Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json