Skip to main content
DELETE
Remove leads

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

The ID of the campaign.

Pattern: ^[0-9a-z]+$

Body

application/json
platform
enum<string>

Platform for platformIds / usernames. Currently optional and defaults to twitter, the only supported platform. It will become required for platformIds / usernames once additional platforms are supported — set it explicitly now to avoid future breakage. Ignored for externalIds, which are platform-agnostic.

Available options:
twitter
platformIds
string[]

Platform user IDs. Maximum 2000 per request.

Required array length: 1 - 2000 elements
Minimum string length: 1
Example:
usernames
string[]

Usernames (handles). Profiles not yet in the system will be fetched automatically. Maximum 2000 per request.

Required array length: 1 - 2000 elements
Minimum string length: 1
Example:
externalIds
string[]

Inbox external IDs (platform-agnostic). Maximum 2000 per request.

Required array length: 1 - 2000 elements
Minimum string length: 1
Example:
leads
object[]

Mixed leads, each identified by platformId, username, or externalId.

Required array length: 1 - 2000 elements

Response

200 - application/json

OK

removed
integer
required

The number of leads that were removed from the campaign.

Required range: 0 <= x <= 9007199254740991