Candidates

Update a candidate

Update the supported fields of an existing candidate profile.

PATCH

/candidates/{candidateId}

Update a candidate

curl --request PATCH \
  --url https://api.cvviz.com/v1/candidates/{candidateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: cvviz-integration-operation-001' \
  --header 'Content-Type: application/json' \
  --data '
{
  "experienceMonths": 48,
  "firstName": "Asha",
  "lastName": "Sharma",
  "skills": [
    "TypeScript",
    "Node.js"
  ]
}
'

{
  "data": {
    "created": false,
    "id": 501,
    "updated": true
  }
}

Send only the fields you want to change. Use the dedicated tag and application-stage endpoints for those changes.

Provide at least one supported field. experienceMonths is measured in months; qualifications is a single text value and skills is an array of strings.

Permissions

candidates.profile.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

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

currentCitystring

Maximum string length: 256

Example: Pune

currentCountrystring

Maximum string length: 256

Example: India

currentStatestring

Maximum string length: 256

Example: Maharashtra

emailstring

Maximum string length: 250

Example: asha@example.com

experienceMonthsinteger

Required range: 0 <= x <= 1200

Example: 72

firstNamestring

Maximum string length: 50

Example: Asha

lastNamestring

Maximum string length: 50

Example: Sharma

phonestring

Maximum string length: 80

Example: +919876543210

qualificationsstring

Maximum string length: 50

Example: B.Tech

skillsstring[]

Maximum array length: 50

sourcestring

Maximum string length: 100

Example: Customer API

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