Skip to main content
PATCH
Update Lead in a Campaign
This endpoint updates the lead and, through it, the contact and the company the lead is linked to: contact fields such as firstName or jobTitle are written on the contact, company fields such as companyName on the company. Only the fields you send change. updateStrategy decides what the lead, its contact and its company keep. overwrite (default): sent values replace stored ones, an empty value clears. overwriteIgnoreEmpty: same, empty values ignored. fillEmptyOnly: only empty fields are filled, identifiers, company link, owner and status kept. Kept values are listed in warnings (FIELDS_KEPT, params.fields: lead variables and contact fields by name, company fields prefixed with company).
companyName alone renames the company the lead is linked to. When the lead has no company yet, it gets linked to a company with that name, created when needed.

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

Query Parameters

updateStrategy
enum<string>
default:overwrite

What the lead, its contact and its company keep. overwrite (default): sent values replace stored ones, an empty string clears. overwriteIgnoreEmpty: empty values ignored. fillEmptyOnly: only empty fields filled, identifiers, links, owner and status kept. Other values: 400.

Available options:
overwrite,
overwriteIgnoreEmpty,
fillEmptyOnly

Body

application/json
firstName
string
lastName
string
companyName
string

New name of the company the lead is linked to, renamed in place. When the lead has no company yet, it gets linked to a company with that name, created when needed.

jobTitle
string
preferredContactMethod
string

Preferred contact method (email, linkedIn)

Response

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

warnings
object[]

Non-blocking notices: the company part was skipped, or FIELDS_KEPT when the update strategy kept values you sent (params.fields names them, company fields prefixed with company).