Skip to main content
POST
/
api
/
client
/
v2
/
prospect-list
/
{id}
/
add-users-to-list
Add Prospects to Existing Prospect List
curl --request POST \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v2/prospect-list/{id}/add-users-to-list \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userUrls": [
    "<string>"
  ],
  "moveOwnDuplicated": true,
  "shouldBeDeletedIfInactive": true,
  "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "status": "success",
  "data": {
    "listId": "cf33282b-b171-4d23-ae02-848499d793e4",
    "submittedUrls": [
      "<string>"
    ],
    "validationRejectedUrls": [
      "<string>"
    ],
    "existedUrlsMap": {},
    "outOfLimitUrls": [
      "<string>"
    ],
    "totalUrlsLimit": 123,
    "perMonthUrlsLimit": 123
  },
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Path Parameters

​
id
string
required

Body

application/json
​
listId
string<uuid>
required

Prospect list id to add URLs to.

​
userUrls
string[]
required

LinkedIn profile URLs to add.

Minimum array length: 1
Minimum string length: 1
​
moveOwnDuplicated
boolean
required

Controls what happens when a submitted URL already exists in another active list of the same owner (any campaign, not just the current one). If true, the existing prospect record is moved into this list — the record itself (id, statistics, flags, connection data) is preserved and simply re-assigned, and the URL is counted in submittedUrls. If false, the URL is skipped and reported in existedUrlsMap keyed by the campaign where the duplicate lives. This flag has no effect in three cases the backend always handles automatically: (1) duplicates in a teammate's or another user's list — always reported in existedUrlsMap, never moved; (2) previously hidden duplicates of the same owner — always reactivated into the target list; (3) exact same-list duplicates — skipped silently.

​
shouldBeDeletedIfInactive
boolean
required

If true, auto-remove prospects who have no posts on LinkedIn within the last 30 days (checked once, when the backend first pulls their posts). If false, keep them regardless of recent posting activity.

​
campaignId
string<uuid>
required

Parent campaign id of listId. Required.

Response

​
status
enum<string>
required

Response status

Available options:
success
​
data
object
required

Detailed result of the add-users-to-list operation

​
message
string
required

Success message

Example:

"Operation completed successfully"