Skip to main content
POST
/
leads
/
pause
/
{leadId}
Pause Lead
curl --request POST \
  --url https://api.lemlist.com/api/leads/pause/{leadId} \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "firstName": "Bastien",
    "lastName": "Velitchkine",
    "companyName": "Bastien VELITCHKINE EI",
    "jobTitle": "Growth Engineer",
    "companyDomain": "bvelitchkine.com",
    "email": "[email protected]",
    "preferredContactMethod": "email",
    "industry": "Technology",
    "Company name": "Bastien Velitchkine",
    "_id": "lea_mizMsAEkRrJuhouYe",
    "isPaused": true,
    "campaignId": "cam_9NsHPnykWESTncCW8",
    "contactId": "ctc_Rofmb6uNGyaPNZ2ni",
    "emailStatus": "deliverable"
  }
]
This endpoint uses the Lead object. Make sure to also check the Contact object to understand the distinction between the two.
Use the campaignId query parameter to pause the lead in a specific campaign only.

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

​
leadId
string
required

The unique identifier of the lead

Query Parameters

​
campaignId
string

ID of the campaign. If provided, pauses the lead only in that campaign.

Response

Success

​
firstName
string
​
lastName
string
​
companyName
string
​
jobTitle
string
​
companyDomain
string
​
email
string<email>
​
preferredContactMethod
string
​
industry
string
​
Company name
string
​
_id
string
​
isPaused
boolean
​
campaignId
string
​
contactId
string
​
emailStatus
string
​
{key}
string