> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.heyreach.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.heyreach.io/_mcp/server. # AddLeadsToCampaign POST https://api//api/public/campaign/AddLeadsToCampaign Content-Type: application/json 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. **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.** Reference: https://docs.heyreach.io/hey-reach-api/campaigns/add-leads-to-campaign ## Request ### Headers - `X-API-KEY` (string, optional) — API key header using this scheme. Example: "X-API-KEY: \{API\_KEY}" ### Body (application/json) This endpoint expects an object. - `campaignId` (integer, required) - `accountLeadPairs` (list of object, required) - `linkedInAccountId` (integer, required) - `lead` (object, required) - `firstName` (string, required) - `lastName` (string, required) - `location` (string, required) - `summary` (string, required) - `companyName` (string, required) - `position` (string, required) - `about` (string, required) - `emailAddress` (string, required) - `customUserFields` (list of object, required) - `name` (string, required) - `value` (string, required) - `profileUrl` (string, required) - `resumeFinishedCampaign` (boolean, required) - `resumePausedCampaign` (boolean, required) ## Response ### 200 OK - `integer` ## Errors ### 400 Add Leads to Campaign Campaigns Request Bad Request Error Bad Request - `errorMessage` (string, required) ### 401 Add Leads to Campaign Campaigns Request Unauthorized Error Unauthorized - `type` (string, required) - `title` (string, required) - `status` (string, required) - `detail` (string, required) - `instance` (string, required) - `ut8c` (object, required) - `laborum__e5` (object, required) - `occaecat100` (object, required) ### 404 Add Leads to Campaign Campaigns Request Not Found Error Not Found - `errorMessage` (string, required) ### 429 Add Leads to Campaign Campaigns Request Too Many Requests Error Too Many Requests - `type` (string, required) - `title` (string, required) - `status` (string, required) - `detail` (string, required) - `instance` (string, required) - `ut8c` (object, required) - `laborum__e5` (object, required) - `occaecat100` (object, required) ## Examples **Request** ```json { "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 } ``` **Response** ```json 0 ``` **SDK Code** ```python import requests url = "https://api//api/public/campaign/AddLeadsToCampaign" payload = { "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 } headers = { "X-API-KEY": "salama", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api//api/public/campaign/AddLeadsToCampaign'; const options = { method: 'POST', headers: {'X-API-KEY': 'salama', 'Content-Type': 'application/json'}, body: '{"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}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api//api/public/campaign/AddLeadsToCampaign" payload := strings.NewReader("{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("X-API-KEY", "salama") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api//api/public/campaign/AddLeadsToCampaign") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["X-API-KEY"] = 'salama' request["Content-Type"] = 'application/json' request.body = "{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api//api/public/campaign/AddLeadsToCampaign") .header("X-API-KEY", "salama") .header("Content-Type", "application/json") .body("{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}") .asString(); ``` ```php request('POST', 'https://api//api/public/campaign/AddLeadsToCampaign', [ 'body' => '{ "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 }', 'headers' => [ 'Content-Type' => 'application/json', 'X-API-KEY' => 'salama', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api//api/public/campaign/AddLeadsToCampaign"); var request = new RestRequest(Method.POST); request.AddHeader("X-API-KEY", "salama"); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"campaignId\": 235,\n \"accountLeadPairs\": [\n {\n \"linkedInAccountId\": 123,\n \"lead\": {\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"location\": \"USA\",\n \"summary\": \"SDR @ HeyReach\",\n \"companyName\": \"HeyReach\",\n \"position\": \"SDR\",\n \"about\": \"I like LinkedIn\",\n \"emailAddress\": \"john_doe@example.com\",\n \"customUserFields\": [\n {\n \"name\": \"favorite_color\",\n \"value\": \"blue\"\n }\n ],\n \"profileUrl\": \"https://www.linkedin.com/in/john-doe\"\n }\n }\n ],\n \"resumeFinishedCampaign\": false,\n \"resumePausedCampaign\": true\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "X-API-KEY": "salama", "Content-Type": "application/json" ] let parameters = [ "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 ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api//api/public/campaign/AddLeadsToCampaign")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```