v2.165.2 - Candidate Notes Visibility

This release introduces a new read-only isPrivate boolean field on candidate notes, which determines the visibility of the note thread.

Data Model Changes

  • isPrivate is included only on parent notes.
  • The value applies to the entire note thread, including replies.

Affected Endpoints

  • GET /candidates/{id}/notes
    • Returns the isPrivate field on parent notes.
  • POST /candidates/{id}/notes
    • Returns isPrivate: false for newly created notes.
    • Private notes cannot be created via the API.
  • PATCH /candidates/{id}/notes/{noteId}
    • Returns the current value of the isPrivate field.
    • The field cannot be updated via the API.

Notes

  • isPrivate is a read-only, informational field.
  • Visibility settings can only be changed from the join app and cannot be changed through public APIs.