Update a candidate application stage

PATCH

/jobs/{jobId}/candidates/{candidateId}/stage

Move a candidate's application to another stage in the job's hiring pipeline.

First read GET /jobs/{jobId}/candidate-stages with candidates.read to find a valid stage. These are candidate stages, not job lifecycle statuses.

Permissions

candidates.write

Safe retries

Send an Idempotency-Key. Retry the same request with the same key to avoid repeating the write. See Safe retries & idempotency.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Mutation applied or safely replayed.

Headers

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠409

🟠429

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.cvviz.com/v1/jobs//candidates//stage' \
--header 'Idempotency-Key: cvviz-integration-operation-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "stageCode": 3,
    "reasonId": 12,
    "remark": "string"
}'

Response Example

200 - Example 1

{
    "data": {
        "stageCode": 3,
        "stageLabel": "Interview",
        "updated": true
    }
}

List candidate job offers

Update job status

Update a candidate application stage

Permissions#

Safe retries#

Request

Responses

Permissions

Safe retries