Skip to main content
POST
/
api
/
client
/
v2
/
prospects
/
move
Move Selected Prospects
curl --request POST \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/prospects/move \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prospectsIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "areAllSelected": true,
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "oldListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "newListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "newListName": "<string>"
}
'
{
  "status": "success",
  "data": {
    "existedUsers": [
      {
        "id": "8d256aa6-9b12-49a7-93ee-bf41634b5b60",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "outOfLimitUsers": [
      {
        "id": "8d256aa6-9b12-49a7-93ee-bf41634b5b60",
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "totalUsersLimit": 123,
    "newListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Body

application/json
​
prospectsIds
string<uuid>[]
required

Prospect record ids to move. Ignored when areAllSelected is true.

​
areAllSelected
boolean
required

If true, the move scope is controlled by variant + oldListId and prospectsIds is ignored. If false, only the ids in prospectsIds are used (and variant is ignored).

​
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 oldListId). campaign — every list in a campaign.

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

Target campaign id.

​
oldListId
string<uuid>

Current list id, if the move starts from a specific list.

​
newListId
string<uuid>

Destination list id, if reusing an existing list.

​
newListName
string

New destination list name, if the backend should create it.

Response

​
status
enum<string>
required

Response status

Available options:
success
​
data
object
required

Bulk move result

​
message
string
required

Success message

Example:

"Operation completed successfully"