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

Owner-user/profile pairs to delete in explicit mode. Each pair deletes that person across the owner's Prospects campaigns in the selected team, not one record or campaign. Read user.id and linkedInProfile.id to construct the pair. Ignored when areAllSelected=true; pass [] in that mode. With areAllSelected=false, [] is a no-op, while a non-empty set matching no record returns not found.

areAllSelected
boolean
required

True selects by variant and listId and ignores targetUsersData. False deletes by the supplied owner-user/profile pairs across that owner's campaigns in the selected team; variant does not control this selection. A supplied listId still triggers a lookup/permission check, so omit it in explicit-pair mode.

variant
enum<string>

Required only for areAllSelected=true. list requires listId; all selects accessible bulk scope and is still narrowed if listId is supplied; campaign is unsupported and returns BadRequest. Omit in explicit owner/profile-pair mode.

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

List ID required for bulk variant=list. If supplied with bulk variant=all it still restricts the query. In explicit owner/profile-pair mode it does not narrow deletion, but still triggers a list lookup and permission check; omit it in that mode.

Response

status
string
required

Response status

Allowed value: "success"
data
null
required

No response payload

message
string
required

Success message

Example:

"Operation completed successfully"