Candidates

Update a candidate

Changed on

Updates the candidate email and/or display name. Omitted fields are left unchanged. Requires candidates.manage. The request is idempotent when an Idempotency-Key header is supplied.

patch/candidates/{id}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/candidates/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The candidate id.

Request body

emailstring email

Absent key leaves the stored email unchanged. The new address must be unique on the account.

displayNamestring

Absent key leaves the stored display name unchanged.

Response

Successful response.

idstring required

Unique identifier for the candidate.

object'candidate' required

String representing the object's type.

emailstring required

The candidate's email address.

displayNamestring nullable required

The candidate's display name.

handlestring nullable required

Public-profile handle, or null.

avatarUrlstring nullable required

Avatar URL, or null.

hasResumeboolean required

Whether a resume is on file. On list rows this reflects the stored pointer; on the single-candidate detail it reflects the resolved blob (always agrees with resume !== null), so the two can briefly disagree if a stored file was garbage-collected.

createdAtstring required

ISO-8601 timestamp of when the candidate registered.

candidateCreatedAtstring required

ISO-8601 timestamp when this Board user became an operator-visible Candidate. This is the reconciliation counterpart of candidate.created, not newsletter permission.

updatedAtstring nullable required

ISO-8601 timestamp of the latest approved Candidate identity update, or null for older rows.

revisioninteger required

Monotonic Candidate lifecycle revision; legacy rows are 0 until the rollout migration runs.

lastActiveAtstring nullable required

ISO-8601 timestamp of the last activity on the board (a sign-in or signed-in use), to the hour, or null.

deactivatedAtstring date-time nullable required

ISO 8601 timestamp when sign-in was disabled, or null when the candidate can sign in. Deactivate revokes all sessions, blocks sign-in, and hides the profile from talent surfaces; profile and application history are preserved. Reactivate restores sign-in and talent-surface visibility; the candidate signs in again to establish a new session.

savedJobCountnumber required

Number of jobs the candidate has saved. Values are capped at 1,000 in write-operation responses (reconcile/deactivate/reactivate/create/update); GET detail returns 422 candidate_resource_limit beyond the cap.

alertCountnumber required

Number of job alerts the candidate has. Values are capped at 1,000 in write-operation responses (reconcile/deactivate/reactivate/create/update); GET detail returns 422 candidate_resource_limit beyond the cap.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status