Skip to content
Docs

Bulk Delete Impact

Preview which running campaigns would lose leads if these leads were deleted.

POST/api/v1/leads/bulk/delete/impact

Requires an API key with the read scope.

Read only. Counts the leads that are still in a running sequence, per campaign, and how many running leads each campaign keeps. Nothing is changed.

Body Parameters#

leadIdsstring[]body
Lead IDs, up to 50,000. Send this or filter, not both.
filterobjectbody
Select leads by filter instead. Keys: search, status, tags (comma separated; a lead must carry all of them), provider, interestStatus, labelId. Matches at most 50,000 leads, newest first.

Response#

dataobject
Show data
campaignsarray
One entry per affected campaign: id, name, status, leads (how many of the selected leads are still running there) and leftAfter (running leads it would keep; 0 means the delete empties it).
leadsInCampaignsinteger
Total of leads across the campaigns.
leadCountinteger
Leads the selection resolved to.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: read
422Neither or both of leadIds and filter were sent

Rate Limit#

  • 300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns (Retry-After, exponential backoff, monitoring X-RateLimit-Remaining), see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026