Skip to main content
POST
Add a note to a candidate

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Body

application/json
text
string
required

The note, 1 to 10000 characters.

Maximum string length: 10000
candidate_id
string<uuid>

Candidate id (profile_interview.id): a note on the candidate. Give this or result_id.

result_id
string<uuid>

Interview result id (interview_result.id): a note on that result. Give this or candidate_id.

visibility
enum<string>
default:team

team (default): the company sees it; private: only you (the private_notes feature).

Available options:
team,
private
mention_profile_ids
string<uuid>[]

Colleagues to mention (profile.id), at most 20; each gets an e-mail with the note (the mentions feature). Not on a private note.

Maximum array length: 20

Response

The note was added.

data
object
required