AddLeadsToCampaignV2 | HeyReach API Documentation

curl -X POST https://api/api/public/campaign/AddLeadsToCampaignV2 \
     -H "X-API-KEY: salama" \
     -H "Content-Type: application/json" \
     -d '{
  "campaignId": 235,
  "accountLeadPairs": [
    {
      "linkedInAccountId": 123,
      "lead": {
        "firstName": "John",
        "lastName": "Doe",
        "location": "USA",
        "summary": "SDR @ HeyReach",
        "companyName": "HeyReach",
        "position": "SDR",
        "about": "I like LinkedIn",
        "emailAddress": "john_doe@example.com",
        "customUserFields": [
          {
            "name": "favorite_color",
            "value": "blue"
          }
        ],
        "profileUrl": "https://www.linkedin.com/in/john-doe"
      }
    }
  ],
  "resumeFinishedCampaign": false,
  "resumePausedCampaign": true
}'

The name field in the customUserFields array of the leads you are importing, must contain only alpha-numeric characters or underscores _. An error will be return in the case the name field does not follow this format.

Add leads to a campaign. Add up to 100 leads per request. If a LinkedIn account Idis specified in the AccountLeadPairs, that lead will be mapped to the accountin the campaign. Same as the **AddLeadsToCampaign** request, however this request returns counts for how many of the leads were added, how many were update and how many failed to be added. **The** **`name`** **field in the** **`customUserFields`** **array of the leads you are importing, must contain only alpha-numeric characters or underscores** **`_`**. **An error will be return in the case the** **`name`** **field does not follow this format.**

Request

This endpoint expects an object.

campaignIdintegerRequired

accountLeadPairslist of objectsRequired

resumeFinishedCampaignbooleanRequired

resumePausedCampaignbooleanRequired

Response

addedLeadsCountinteger

updatedLeadsCountinteger

failedLeadsCountinteger

Errors

400

Add Leads to Campaign V2campaigns Request Bad Request Error

401

Add Leads to Campaign V2campaigns Request Unauthorized Error

404

Add Leads to Campaign V2campaigns Request Not Found Error

429

Add Leads to Campaign V2campaigns Request Too Many Requests Error

Headers

Request

Response

Errors