Skip to main content
DELETE
Remove Leads from Campaign
CLI:

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