Add a candidate note
POST
/candidates/{candidateId}/notes
Permissions
notes.writeSafe retries
Idempotency-Key. Retry the same request with the same key to avoid repeating the write. See Safe retries & idempotency.Request
Path Params
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.cvviz.com/v1/candidates//notes' \
--header 'Idempotency-Key: cvviz-integration-operation-001' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"note": "Candidate is available for an interview next week."
}'Response Response Example
200 - Example 1
{
"data": {
"id": 7301,
"entityType": "candidate",
"entityId": 501,
"created": true
}
}