Skip to main content
POST
/
v1
/
candidates
/
update-stage
Update candidate stage
curl --request POST \
  --url https://api.stardex.ai/v1/candidates/update-stage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "job_name": "<string>",
  "candidate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "candidate_email": "jsmith@example.com",
  "candidate_name": "<string>",
  "stage_id": "<string>",
  "stage_name": "<string>"
}
'
{
  "success": true,
  "data": {
    "candidate_id": "123e4567-e89b-12d3-a456-426614174000",
    "person_id": "234e5678-e90a-12b3-c456-789012345678",
    "job_id": "234e5678-e90a-12b3-c456-789012345678",
    "previous_stage_id": "345e6789-e01b-23c4-d567-890123456789",
    "new_stage_id": "456e7890-e12b-34d5-a678-901234567890"
  }
}

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. Provide either job_id or job_name. Get IDs from POST /v1/jobs/search.

​
job_name
string

Job title to match. Used when job_id is not provided.

Minimum string length: 1
​
candidate_id
string<uuid>

Candidate UUID. 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