Candidates
Update candidate
Update a candidate — partial update, send only the fields you want to change
PATCH
Send only the fields you want to change. All fields except
candidate_id are optional.
Authentication
string
required
Bearer authentication header of the form
Bearer <token>, where <token> is your API token.Request Body
string
required
The candidate to update.
string
New pipeline status. One of:
applied screening phone_screen interview technical offer hired rejected withdrawn on_hold shortlisted qualified uploaded.string[]
Array of free-form tags. Replaces the existing tag list.
string
Talent-pool stage. One of:
cold warm hot not_interested. Pass null to clear.string
Recruiter note attached to the candidate (used in follow-up emails). Pass
null to clear.At least one field beyond
candidate_id must be provided. Otherwise the response is 400 At least one updatable field must be provided.Response
boolean
Indicates if the candidate status was updated successfully
string
The unique identifier of the updated candidate
string
The new pipeline status of the candidate