Skip to main content
DELETE
/
api
/
campaigns
/
{id}
/
leads
Remove Leads from Campaign
curl --request DELETE \
  --url https://app.puffle.ai/api/campaigns/{id}/leads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "prospect_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "all": true
}
'
{
  "deleted": 4503599627370495
}
CLI: 
puffle campaign lead remove --id <id>
puffle campaign lead remove --id <id> --prospect-ids <prospect-ids> --all

​
Overview

Delete leads from a draft campaign. Call with { all: true } to clear the entire roster, or { prospect_ids: [...] } to cherry-pick up to 500 at a time. Campaign stats are recomputed atomically after the delete.
This operation shares the URL path /api/campaigns/{id}/leads with other verbs. See the sibling page for related operations on the same resource.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Campaign UUID

Body

application/json
​
prospect_ids
string<uuid>[]
Required array length: 1 - 500 elements
​
all
enum<boolean>
Available options:
true

Response

Leads deleted successfully.

​
deleted
required
Required range: 0 <= x <= 9007199254740991