Skip to main content
POST
Create prospect list with LinkedIn profile URLs

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json

URL admission precedes asynchronous profile verification. Check submittedUrls, validationRejectedUrls, existedUrlsMap and outOfLimitUrls. With at least one accepted URL, partial success is returned; if none are accepted, including a wholly out-of-capacity batch, the default flow fails rather than returning empty success.

listName
string
required

Human-readable list name.

Minimum string length: 1
campaignId
string<uuid>
required

Use a non-deleted Prospects campaign as the destination. Capacity is normally workspace-wide, but a trial pool with a non-null perOwnerCeiling is measured for this campaign owner. An active plan is required; a new list also needs a free prospect-list slot in that campaign.

userUrls
string[]
required

LinkedIn profile URLs to seed the list with.

Required array length: 1 - 1000 elements
Minimum string length: 1
moveOwnDuplicated
boolean
required

For an active duplicate owned by the destination campaign owner, true moves the existing prospect record into this list and false skips it into existedUrlsMap. Same-list duplicates are skipped silently; deleted same-owner records are reactivated. Teammate duplicates are searched and skipped only when the destination campaign has skipTeammatesLeads enabled; this is not global team-wide deduplication.

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. Useful for pruning low-signal prospects on create.

Response

status
string
required

Response status

Allowed value: "success"
data
object
required

Detailed result of the create-list operation

message
string
required

Success message

Example:

"Operation completed successfully"