Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiDeterministic

Add prospects bulk

POST /api/campaigns/{campaignId}/prospects/bulk

Add multiple prospects to a campaign at once. Maximum 1000 per request. Each prospect must include a valid linkedinUrl (https://linkedin.com/in/<slug>); firstName/lastName/email/company/position are optional. Custom fields beyond those are stored as customFields. For imports >1000, chunk client-side: omit prospectListId on the first call to create a list (response returns prospectListId), then pass that same prospectListId on subsequent calls so all chunks land in the same list. The Pipeline CLI exposes a sugar wrapper `pipeline import-prospects --file leads.csv --campaign-id X` that handles the chunking automatically. Returns { added, failed, errors, prospectListId }.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

campaignIdrequired

string

No description.

prospectsrequired

object[]

No description.

prospectListId

string

Optional. Append to this existing prospect list instead of creating a new one. Returned in the response of the first chunk - pass it back on subsequent chunks of a paginated import.

prospectListName

string

Optional. Custom name for the prospect list created when prospectListId is omitted.

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/campaigns/00000000-0000-4000-8000-000000000000/prospects/bulk" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prospects":[{}]}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.