Add a note to a candidate by external ID

Records a note against the candidate. Notes are free text and searchable — they feed the same index as the candidate's CV, so the candidate becomes findable on words in the note shortly afterwards. Notes are never shown to candidates. priority and sourceTime place the re-index in the processing queue, exactly as on a candidate update; they default to priority 0 and the time of the request.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your own id for the candidate

Body Params

The note to add.

A note to record against a candidate.

string
required
length between 1 and 20000

The note, as free text. Leading and trailing whitespace is trimmed, and the result must not be empty — a string of only spaces is a 400. Searchable: it feeds the same index as the candidate's CV.

integer
0 to 2

Priority band for re-indexing the candidate: 0 (most urgent, the default), 1 or 2. Same bands as a candidate update.

date-time

The change time that orders a priority band (ISO 8601). Defaults to the time of the request.

Responses

400

The note is empty or longer than 20,000 characters.

404

No candidate with this external ID in your organization.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json