Skip to main content
POST
/
api
/
client
/
v1
/
prospects
Add Prospect
curl --request POST \
  --url https://prod-nginx-v2.goextrovert.com/webgateway/api/client/v1/prospects \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "prospectListId": "cf33282b-b171-4d23-ae02-848499d793e4",
  "prospectProfileUrl": "https://www.linkedin.com/in/john-doe",
  "campaignId": "8d256aa6-9b12-49a7-93ee-bf41634b5b60",
  "moveDuplicatedProspect": true
}
'
{
  "status": "success",
  "data": null,
  "message": "Operation completed successfully"
}

Authorizations

​
X-API-Key
string
header
required

API Key for authentication

Body

application/json
​
prospectListId
string<uuid>
required

ID of the prospect list to add the prospect to.

Example:

"cf33282b-b171-4d23-ae02-848499d793e4"

​
prospectProfileUrl
string
required

LinkedIn profile URL of the prospect to add.

Example:

"https://www.linkedin.com/in/john-doe"

​
campaignId
string<uuid>
required

ID of the campaign that owns the prospect list.

Example:

"8d256aa6-9b12-49a7-93ee-bf41634b5b60"

​
moveDuplicatedProspect
boolean
required

Controls behavior when the prospect already exists in another list or campaign of the same owner. If true, the prospect is moved into this list and campaign. If false, the request fails with an error.

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"