1. Candidates
CVViZ API Documentation
  • Start here
    • Quickstart
    • Authentication & permissions
  • Guides
    • API concepts
    • Create a job
    • Find candidates and download resumes
    • Pagination & filtering
    • Rate limits & usage
    • Errors & troubleshooting
    • Safe retries & idempotency
  • Jobs
    • Create a job
      POST
    • List jobs
      GET
    • Get a job
      GET
    • Update a job
      PATCH
    • List candidates for a job
      GET
    • List job benchmark resumes
      GET
    • List candidate job offers
      GET
    • Update a candidate application stage
      PATCH
    • Update job status
      PATCH
  • Candidates
    • List candidates
      GET
    • Get a candidate
      GET
    • Update a candidate
      PATCH
    • List applications for a candidate
      GET
    • List candidate events
      GET
    • List candidate documents
      GET
    • Download a candidate resume
      GET
  • Tasks
    • List tasks
    • Create a task
    • Update a task
    • Update task completion
  • Notes & tags
    • List job notes
    • Add a job note
    • List tags for a job
    • Add tags to a job
    • List tags for a candidate
    • Add tags to a candidate
    • List candidate notes
    • Add a candidate note
    • List candidate tags
  • Screening & interviews
    • List job pre-screening questions
    • List candidate screening answers
    • List candidate interview feedback
  • Organization & lookup data
    • List candidate stages for a job
    • Get job creation options
    • List industries
    • List job functions
    • List employer types
    • List client companies
    • List account users
    • List departments
    • List hiring managers
    • List candidate grades
  1. Candidates

Update a candidate

PATCH
/candidates/{candidateId}
Update the supported fields of an existing candidate profile.
Send only the fields you want to change. Use the dedicated tag and application-stage endpoints for those changes.

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.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
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 Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.cvviz.com/v1/candidates/' \
--header 'Idempotency-Key: cvviz-integration-operation-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Asha",
    "lastName": "Sharma",
    "email": "asha@example.com",
    "phone": "+919876543210",
    "source": "Customer API",
    "experienceMonths": 72,
    "qualifications": "B.Tech",
    "skills": [
        "Node.js",
        "TypeScript"
    ],
    "currentCity": "Pune",
    "currentState": "Maharashtra",
    "currentCountry": "India"
}'
Response Response Example
200 - Example 1
{
    "data": {
        "id": 501,
        "created": true,
        "updated": false
    }
}
Previous
Get a candidate
Next
List applications for a candidate
Built with