Skip to main content
POST
Move Selected Prospects

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json
prospectsIds
string<uuid>[]
required

Explicit prospect record IDs, not profile IDs. Ignored when areAllSelected=true; pass [] in that mode. In explicit mode use a non-empty selection: [] moves no prospects, but newListName may still create an empty destination list before selection is resolved.

Maximum array length: 1000
areAllSelected
boolean
required

True selects by variant and optional oldListId and ignores prospectsIds. False selects the explicit prospect record IDs; variant is then ignored by selection but remains required and validated. In both modes oldListId, when supplied, triggers a permission check and requires every selected record to belong to that list.

variant
enum<string>
required

Required validated selector. With areAllSelected=true: list requires oldListId; all selects the accessible bulk scope and is still narrowed if oldListId is supplied; campaign is unsupported and returns BadRequest. With areAllSelected=false, selection ignores variant, but a valid enum value is still required.

Available options:
all,
list,
campaign
newListId
string<uuid>
required

Existing destination list ID; it must belong to campaignId. Supply exactly one of newListId and newListName; omit newListName, do not pass null or an empty string.

campaignId
string<uuid>
required

Destination campaign ID, not the source-selection scope. If newListId is used, that list must belong to this campaign. The destination must be a usable Prospects campaign in the same team and the plan must be active; moving already-visible prospects does not require free Prospect Capacity.

oldListId
string<uuid>

Optional source-list constraint. Required for bulk variant=list; when supplied with explicit IDs or bulk variant=all, every selected record must belong to this list. It also causes a read/permission check; omit it when no source-list guard is intended.

newListName
string

Non-empty destination list name to create in campaignId; this creates a new list, not a rename. Supply exactly one of newListId and newListName; omit newListId, do not pass null or an empty string.

Minimum string length: 1

Response

status
string
required

Response status

Allowed value: "success"
data
object
required

Bulk move result

message
string
required

Success message

Example:

"Operation completed successfully"