Update a lead's details

Updates the details of an existing lead. In addition to the fields on the candidate, this endpoint accepts an optional candidate.labels object to add or remove labels on the candidate in a single request.

Labels payload (optional): When candidate.labels is provided, it MUST include both an add and a remove array (send an empty array if you don't need that side). All names referenced in add/remove must already exist as company labels (create them first via POST /company/labels); if any are missing the whole request fails with 422 and nothing is changed. Names that don't exist as labels yet cause the whole request to fail with 422, and no labels are modified — the change is all-or-nothing.

Path Params
integer
required

ID of the lead to update.

Query Params
string
required

API key of your account.

Body Params
candidate
object
required
Responses
200

Candidate has been successfully updated.

404

Campaign Invitation not found for this company

500

Internal server error, we will provide you with the exception message of the application.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!