Update candidate contact information

Updates a candidate’s contact details. Only the listed fields can be changed; at least one must be provided.

Authentication

AuthorizationBearer

Supabase-issued user JWT. Send as Authorization Bearer header. Dedicated API keys are planned for a future release.

Path parameters

candidateIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.
first_namestringOptional
last_namestringOptional
emailstringOptionalformat: "email"
phonestringOptional
citystringOptional
statestringOptional

Response

The updated candidate.
candidate_idstringOptionalformat: "uuid"
org_idstringOptionalformat: "uuid"
first_namestringOptional
last_namestringOptional
emailstring or nullOptionalformat: "email"
phonestring or nullOptional
address_line1string or nullOptional
address_line2string or nullOptional
citystring or nullOptional
statestring or nullOptional
postal_codestring or nullOptional
countrystring or nullOptional
sourcestring or nullOptional

Where the candidate came from (e.g. indeed, referral, manual).

applicationslist of objectsOptional
The candidate's applications, when included in the response.
created_atdatetimeOptional
updated_atdatetimeOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error