Skip to main content
POST
Update candidate stage

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Body

application/json
job_id
string<uuid>

Job UUID. Highest-precedence job identifier. Get IDs from POST /v1/jobs/search.

job_name
string

Job title to match. Used only when job_id and candidate_id do not resolve a job. If no job is resolved, the endpoint falls back to the person’s most recent active candidacy created within the previous 180 days.

Minimum string length: 1
candidate_id
string<uuid>

Candidate UUID. Its associated job is used after an explicit job_id and before job_name. Provide candidate_id, candidate_email, or candidate_name.

candidate_email
string<email>

Candidate email to look up. Used when candidate_id is not provided.

candidate_name
string

Candidate full name to look up. Fallback when email and ID are not provided.

Minimum string length: 1
stage_id
string

Target pipeline stage UUID. Provide either stage_id or stage_name. Get IDs from GET /v1/jobs/{id} → pipeline_stages.

Minimum string length: 1
stage_name
string

Target pipeline stage name (e.g. "Technical Interview"). Used when stage_id is not provided.

Minimum string length: 1

Response

Stage updated successfully

success
boolean
required

Whether the stage update succeeded.

data
object
required