Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
Lead

Delete leads in bulk

Delete multiple leads from a campaign or list based on filters. You must provide either campaign_id or list_id. Optionally filter by status or specific IDs.

Requires one of the following scopes: leads:delete, leads:all, all:delete, all:all

delete/api/v2/leads

Request body

OR

Example request

{
  "campaign_id": "019f94cd-aeef-73a5-ad61-6469412d4864",
  "list_id": "019f94cd-aeef-73a5-ad61-646acab34cd1",
  "status": 3,
  "ids": [
    "019f94cd-aeef-73a5-ad61-646b0e71e024"
  ],
  "limit": 100
}

Response

Default Response

countinteger

Number of leads successfully deleted.

Example response

{
  "count": 5
}