Skip to main content
POST
Delete Selected Prospects

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json
targetUsersData
object[]
required

Persons to delete (as user + LinkedIn profile pairs). Ignored when areAllSelected is true.

areAllSelected
boolean
required

If true, the deletion scope is controlled by variant + listId and targetUsersData is ignored. If false, only the entries in targetUsersData are used (and variant/listId are ignored).

rejectAllPostsActivities
boolean
required

If true, rejects the affected prospects' posts currently in 'Need approval' status. Posts in 'Pending' status are not affected.

variant
enum<string>
required

Scope of the bulk selection. Only used when areAllSelected is true; ignored otherwise. all — all visible prospects. list — a specific prospect list (use together with listId). campaign — every list in a campaign.

Available options:
all,
list,
campaign
listId
string<uuid>

List id that scopes the bulk selection when variant is list. Only used when areAllSelected is true.

Response

status
enum<string>
required

Response status

Available options:
success
data
any | null
required

No response payload

Available options:
null
Example:

null

message
string
required

Success message

Example:

"Operation completed successfully"