Add Leads

Add one or more leads to an existing campaign

POST /api/v1/leads

cURL

curl -X POST https://api.sendpilot.ai/api/v1/leads \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "camp_xyz789",
    "leads": [
      {
        "linkedinUrl": "https://www.linkedin.com/in/john-doe",
        "firstName": "John",
        "lastName": "Doe",
        "company": "TechCorp",
        "title": "VP of Engineering"
      },
      {
        "linkedinUrl": "https://www.linkedin.com/in/jane-smith",
        "firstName": "Jane",
        "lastName": "Smith",
        "customFields": {
          "referredBy": "Conference 2024"
        }
      }
    ]
  }'

201

{
  "success": true,
  "leadsAdded": 2,
  "duplicatesSkipped": 0,
  "invalidEntries": 0
}

Add new leads to an existing campaign. The leads will be queued for processing according to the campaign’s sequence.

Request

X-API-Key · string · required

Your API key

campaignId · string · required

The campaign ID to add leads to

leads · array · required

Array of lead objects to add (max 100 per request)

Show Lead Object

linkedinUrl · string · required

LinkedIn profile URL of the lead

firstName · string

Lead’s first name (optional, will be scraped if not provided)

lastName · string

Lead’s last name (optional, will be scraped if not provided)

email · string

Lead’s email address

company · string

Lead’s company name

title · string

Lead’s job title

customFields · object

Custom fields for personalization (key-value pairs)

Response

success · boolean

Whether the operation completed successfully

leadsAdded · integer

Number of leads successfully added

duplicatesSkipped · integer

Number of leads skipped (already exist in campaign)

invalidEntries · integer

Number of leads with invalid data

errors · array

Array of error objects for leads that failed validation (only present if there are errors)

Show Error Object

index · integer

Index of the failed lead in the input array

linkedinUrl · string

The LinkedIn URL that failed

reason · string

Reason for the failure

cURL

curl -X POST https://api.sendpilot.ai/api/v1/leads \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaignId": "camp_xyz789",
    "leads": [
      {
        "linkedinUrl": "https://www.linkedin.com/in/john-doe",
        "firstName": "John",
        "lastName": "Doe",
        "company": "TechCorp",
        "title": "VP of Engineering"
      },
      {
        "linkedinUrl": "https://www.linkedin.com/in/jane-smith",
        "firstName": "Jane",
        "lastName": "Smith",
        "customFields": {
          "referredBy": "Conference 2024"
        }
      }
    ]
  }'

201

{
  "success": true,
  "leadsAdded": 2,
  "duplicatesSkipped": 0,
  "invalidEntries": 0
}

Duplicate detection is based on the LinkedIn URL. If a lead with the same URL already exists in the campaign, it will be skipped.