Skip to main content

Update a candidate

Update a curated set of candidate fields. Scope: candidates:write.

PATCH/api/v1/candidates/{id} 🔒 API key

Updates a curated subset of a candidate’s fields. Scope: candidates:write. Requires employer-write authority in one of the candidate’s organizations (admins bypass; hiring managers are read-only). Send only the fields you want to change — unknown fields are ignored, wrong-typed fields return 400.

Path parameters

ParameterTypeDescription
idstringThe candidate id.

Request body

FieldTypeDescription
fullNamestringCandidate’s full name.
statusstringCandidate status.
emailstring | nullEmail (validated).
phonestring | nullPhone (validated).
summarystring | nullFree-text summary.

Example request

curl -X PATCH https://app.talent-ray.com/api/v1/candidates/cand_1 \
  -H "Authorization: Bearer tr_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "Active", "phone": "+905551112233" }'

Response

200 OK — the updated candidate (same shape as Get a candidate).

Status codes

StatusMeaning
200Updated.
400bad_request — invalid or empty body.
401No valid API key.
403insufficient_scope (missing candidates:write) or forbidden (no write authority in the candidate’s org).
404Not found, or not visible to the key.
429Rate limit exceeded.