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": "[email protected]",
  "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

Enter your API key as: Bearer your_api_key_here

Body

application/json
​
job_id
string<uuid>

The unique identifier for the job. Use this if you have the specific job ID available.

​
job_name
string

The title of the job posting. If you don't provide a Job ID, we'll find the job by this name.

Minimum string length: 1
​
candidate_id
string<uuid>

The unique identifier for the candidate. Use this if you have the specific candidate ID available.

​
candidate_email
string<email>

The candidate's email address. We'll use this to find the candidate if you don't provide a Candidate ID.

​
candidate_name
string

The candidate's full name. We'll use this to find the candidate if email and ID aren't provided.

Minimum string length: 1
​
stage_id
string

The unique identifier for the pipeline stage. Use this if you have the specific stage ID available.

Minimum string length: 1
​
stage_name
string

The name of the pipeline stage. Use this if you have the specific stage name available.

Minimum string length: 1

Response

Stage updated successfully

​
success
boolean
required

Whether the operation was successful

​
data
object
required