API Reference

Update a candidate note

patch
https://api.joinpopp.com/v1/candidates//notes/

Replaces the content of a note you added. The candidate is re-indexed, so search reflects the new wording shortly afterwards. Notes synced from your ATS cannot be edited here — edit them in your ATS, or the next sync will overwrite the change. 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
uuid
required

The Popp candidate id

uuid
required

The Popp note id, from the list or create response

Body Params

The replacement content.

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 such candidate in your organization, or no such note on that candidate.

409

The note is synced from your ATS and is read-only here.

Updated 6 days ago

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

Updated 6 days ago

Did this page help you?