Skip to navigation
Vendor/ Customer APIsLead

Replace a lead

View as MarkdownOpen in Claude

Replaces the lead with the object in the body. Any writable field you omit is cleared, so send the whole record - use PATCH if you only want to change a few fields and leave the rest alone.

Approval state and archiving are not settable here and are never affected by a replace - use the approve, reject and archive endpoints.

Authentication

X-API-KEYstring

Your vendor API key. Required on every request under /api/v1/vendors/**.

Path parameters

leadIdlongRequired
ID of the lead.

Request

This endpoint expects an object.
firstNamestringRequired
emailAddressstringRequiredformat: "email"
companyNamestringRequired
lastNamestring or nullOptional
phoneNumberstring or nullOptional
linkedInUrlstring or nullOptional
websiteUrlstring or nullOptional
companySizestring or nullOptional
industrystring or nullOptional
jobTitlestring or nullOptional
citystring or nullOptional
statestring or nullOptional
countrystring or nullOptional
sourcelong or nullOptional
Id of a lead source dropdown value configured for your account.
statuslong or nullOptional
Id of a lead status dropdown value configured for your account.
leadAgeinteger or nullOptional
productsInterestedstring or nullOptional
businessImpactMetricsstring or nullOptional
externalIdstring or nullOptional
Your own identifier for this lead. Stored and echoed back unchanged.

Response

Lead replaced successfully.
successbooleanOptional
messagestring or nullOptional
dataobjectOptional
timestampdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error