Update Lead in a Campaign

Updates an existing lead’s information in a specific campaign.

PATCH /campaigns/{campaignId}/leads/{leadId}

Update Lead in a Campaign

cURL

curl --request PATCH \
  --url https://api.lemlist.com/api/campaigns/{campaignId}/leads/{leadId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "preferredContactMethod": "email"
}
'

200

{
  "campaignId": "cam_bSn8EORHQxbWPjHvu",
  "campaignName": "NEW TO DELETE",
  "leadUrl": "https://api.lemlist.com/api/leads/alex.doe%40example.com",
  "firstName": "John",
  "lastName": "Doe",
  "companyName": "Acme Inc",
  "jobTitle": "Growth Engineer",
  "companyDomain": "example.com",
  "email": "[e-mail]",
  "preferredContactMethod": "email",
  "_id": "lea_fiDpiGV585wy3Oii2",
  "isPaused": false,
  "contactId": "ctc_xW8Ou6C03Csv8vatp",
  "emailStatus": "deliverable"
}

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

leadId · string · required

The unique identifier of the lead

Body

application/json

firstName · string

lastName · string

companyName · string

jobTitle · string

preferredContactMethod · string

Preferred contact method (email, linkedIn)

Response

200

application/json

Success

campaignId · string

campaignName · string

leadUrl · string

URL to access the lead

email · string<email>

firstName · string

lastName · string

companyName · string

jobTitle · string

companyDomain · string

preferredContactMethod · string

_id · string

isPaused · boolean

Whether the lead is paused in the campaign

contactId · string

Associated contact ID

emailStatus · string

Email verification status