Applications

Update a candidate application stage

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

PATCH

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

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

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

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.

Authorizations

Authorizationstringheaderrequired

Use Authorization: Bearer <api-credential>.

Path Parameters

jobIdnumberrequired

CVViZ job identifier.

Example: 901

candidateIdnumberrequired

CVViZ candidate identifier.

Example: 501

Headers

Idempotency-Keystringheaderrequired

Unique key for this write: 8-128 letters, digits, periods, underscores, colons or hyphens. Reusing the same key with the same request replays its original result; different content returns 409.

Required string length: 8 - 128

Pattern: ^[A-Za-z0-9._:-]{8,128}$

Example: cvviz-integration-operation-001

Body

reasonIdinteger | null

Required range: 1 <= x

Example: 12

remarkstring | null

Maximum string length: 1000

stageCodeintegerrequired

A stage code returned by the job candidate-stages endpoint.

Example: 3

Response

Mutation applied or safely replayed.

X-API-Daily-Limitintegerheader

Daily account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x

X-API-Daily-Remainingintegerheader

Requests remaining in the daily window after admission.

Required range: 0 <= x

X-API-Daily-Resetstringheader

Daily window reset time in UTC.

X-API-Monthly-Limitintegerheader

Monthly account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x

X-API-Monthly-Remainingintegerheader

Requests remaining in the monthly window after admission.

Required range: 0 <= x

X-API-Monthly-Resetstringheader

Monthly window reset time in UTC.

X-Request-IDstringheader

Request correlation identifier.

X-API-Contractstringheader

Response envelope contract version.

Example: canonical-v1

RateLimit-Limitintegerheader

Example: 600

RateLimit-Remainingintegerheader

Example: 598

RateLimit-Resetintegerheader

Example: 30

dataobjectrequired

Show child attributes

Still need help? Ask the team