Lemlist Developer Docs

Create Lead in Campaign

curl --request POST \
  --url https://api.lemlist.com/api/campaigns/{campaignId}/leads/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "support@lemlist.com",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "lemlist",
  "jobTitle": "Developer",
  "linkedinUrl": "https://www.linkedin.com/in/johndoe",
  "phone": "+33 123456789",
  "timezone": "Europe/Paris",
  "contactOwner": "login_email@lemlist.com"
}
'

import requests

url = "https://api.lemlist.com/api/campaigns/{campaignId}/leads/"

payload = {
    "email": "support@lemlist.com",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "lemlist",
    "jobTitle": "Developer",
    "linkedinUrl": "https://www.linkedin.com/in/johndoe",
    "phone": "+33 123456789",
    "timezone": "Europe/Paris",
    "contactOwner": "login_email@lemlist.com"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'support@lemlist.com',
    firstName: 'John',
    lastName: 'Doe',
    companyName: 'lemlist',
    jobTitle: 'Developer',
    linkedinUrl: 'https://www.linkedin.com/in/johndoe',
    phone: '+33 123456789',
    timezone: 'Europe/Paris',
    contactOwner: 'login_email@lemlist.com'
  })
};

fetch('https://api.lemlist.com/api/campaigns/{campaignId}/leads/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/campaigns/{campaignId}/leads/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"support@lemlist.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"companyName\": \"lemlist\",\n  \"jobTitle\": \"Developer\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/johndoe\",\n  \"phone\": \"+33 123456789\",\n  \"timezone\": \"Europe/Paris\",\n  \"contactOwner\": \"login_email@lemlist.com\"\n}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/campaigns/{campaignId}/leads/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'support@lemlist.com',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'companyName' => 'lemlist',
    'jobTitle' => 'Developer',
    'linkedinUrl' => 'https://www.linkedin.com/in/johndoe',
    'phone' => '+33 123456789',
    'timezone' => 'Europe/Paris',
    'contactOwner' => 'login_email@lemlist.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "campaignId": "cam_bSn8EORHQxbWPjHvu",
  "campaignName": "NEW TO DELETE",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "lemlist",
  "jobTitle": "GTM Engineer",
  "companyDomain": "example.com",
  "email": "support@lemlist.com",
  "_id": "lea_fiDpiGV585wy3Oii2",
  "isPaused": false,
  "contactId": "ctc_xW8Ou6C03Csv8vatp"
}

"No API key provided"

"The authentication you supplied is incorrect"

"User linked to this API key is blocked"

"No user found for this API key"

POST

campaigns

{campaignId}

leads

Create Lead in Campaign

curl --request POST \
  --url https://api.lemlist.com/api/campaigns/{campaignId}/leads/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "support@lemlist.com",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "lemlist",
  "jobTitle": "Developer",
  "linkedinUrl": "https://www.linkedin.com/in/johndoe",
  "phone": "+33 123456789",
  "timezone": "Europe/Paris",
  "contactOwner": "login_email@lemlist.com"
}
'

import requests

url = "https://api.lemlist.com/api/campaigns/{campaignId}/leads/"

payload = {
    "email": "support@lemlist.com",
    "firstName": "John",
    "lastName": "Doe",
    "companyName": "lemlist",
    "jobTitle": "Developer",
    "linkedinUrl": "https://www.linkedin.com/in/johndoe",
    "phone": "+33 123456789",
    "timezone": "Europe/Paris",
    "contactOwner": "login_email@lemlist.com"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: 'support@lemlist.com',
    firstName: 'John',
    lastName: 'Doe',
    companyName: 'lemlist',
    jobTitle: 'Developer',
    linkedinUrl: 'https://www.linkedin.com/in/johndoe',
    phone: '+33 123456789',
    timezone: 'Europe/Paris',
    contactOwner: 'login_email@lemlist.com'
  })
};

fetch('https://api.lemlist.com/api/campaigns/{campaignId}/leads/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://api.lemlist.com/api/campaigns/{campaignId}/leads/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"support@lemlist.com\",\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"companyName\": \"lemlist\",\n  \"jobTitle\": \"Developer\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/johndoe\",\n  \"phone\": \"+33 123456789\",\n  \"timezone\": \"Europe/Paris\",\n  \"contactOwner\": \"login_email@lemlist.com\"\n}"

response = http.request(request)
puts response.read_body

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lemlist.com/api/campaigns/{campaignId}/leads/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'support@lemlist.com',
    'firstName' => 'John',
    'lastName' => 'Doe',
    'companyName' => 'lemlist',
    'jobTitle' => 'Developer',
    'linkedinUrl' => 'https://www.linkedin.com/in/johndoe',
    'phone' => '+33 123456789',
    'timezone' => 'Europe/Paris',
    'contactOwner' => 'login_email@lemlist.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "campaignId": "cam_bSn8EORHQxbWPjHvu",
  "campaignName": "NEW TO DELETE",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "lemlist",
  "jobTitle": "GTM Engineer",
  "companyDomain": "example.com",
  "email": "support@lemlist.com",
  "_id": "lea_fiDpiGV585wy3Oii2",
  "isPaused": false,
  "contactId": "ctc_xW8Ou6C03Csv8vatp"
}

"No API key provided"

"The authentication you supplied is incorrect"

"User linked to this API key is blocked"

"No user found for this API key"

This endpoint uses the Lead object. Make sure to also check the Contact object to understand the distinction between the two.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId

string

required

The unique identifier of the campaign

Query Parameters

deduplicate

boolean

Search email address in other campaigns. Will not insert the lead if email address already exists. Default: false

linkedinEnrichment

boolean

Run the LinkedIn enrichment. Default: false

findEmail

boolean

Find verified email. Default: false

verifyEmail

boolean

Verify existing email (debounce). Default: false

findPhone

boolean

Find phone number. Default: false

Body

application/json

string

Email of the lead

firstName

string

First name of the lead

lastName

string

Last name of the lead

companyName

string

Company name

jobTitle

string

Job title

linkedinUrl

string

LinkedIn profile URL

picture

string

Profile picture URL

phone

string

Phone number

companyDomain

string

Company domain

icebreaker

string

Personalized icebreaker message

timezone

string

Lead's timezone in IANA format (e.g., Europe/Paris, America/New_York)

contactOwner

string

Contact owner (user ID or user login email)

Response

Success

campaignId

string

campaignName

string

string<email>

firstName

string

lastName

string

companyName

string

jobTitle

string

companyDomain

string

_id

string

isPaused

boolean

Whether the lead is paused in the campaign

contactId

string

Associated contact ID

Getting started

Popular Resources

Endpoints

Objects & Definitions

Create Lead in Campaign

Authorizations

Path Parameters

Query Parameters

Body

Response