Candidates

Replace a candidate profile

Changed on

Replaces the selected profile projection. The write body is a desired-state projection, not the GET response shape: scalars are top-level, and read-only fields are rejected. Absent keys are left unchanged; null on a scalar clears it; providing a collection array replaces that collection wholesale (empty array clears). Requires candidates.manage. The request is idempotent when an Idempotency-Key header is supplied.

put/candidates/{id}/profile

Request

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

Path parameters

idstring required

The candidate id.

Request body

headlinestring nullable

Absent key leaves the stored headline unchanged; null clears it.

biostring nullable

Absent key leaves the stored bio unchanged; null clears it.

locationstring nullable

Absent key leaves the stored location unchanged; null clears it.

countryCodestring nullable

Absent key leaves the stored country code unchanged; null clears it. Ignored without an error while the candidate has a home place that this request keeps (a changed location removes it): the country code is then that place's country.

skillsstring[]

Absent key leaves the stored skills unchanged. Providing an array replaces the collection wholesale (empty array clears). Maximum 200 rows.

Response

Successful response.

idstring required

Unique identifier for the candidate.

emailstring required

The candidate's email address.

displayNamestring nullable required

The candidate's display name.

revisioninteger required

Monotonic Candidate lifecycle revision.

profileRevisioninteger required

Monotonic profile-projection revision.

deactivatedAtstring date-time nullable required

ISO 8601 timestamp when sign-in was disabled, or null when active.

skillsstring[] required

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