API Reference

Create a candidate note

post
https://api.join.com/v3/candidates//notes

Adds a note to a candidate.

  • API-created notes are visible to the whole company and have no individual author.
  • Content is limited to 2,500 characters and cannot be edited after creation.
  • A candidate with 50 or more notes cannot receive a new note (note_limit_reached). Delete an existing note before adding another.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the candidate

Body Params

A note created through the API has no author and is always visible to your whole company.

string
required
length between 1 and 2500

The note text

Headers
string

Selects a dated API revision in YYYY-MM-DD format, such as 2026-11-01. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Updated about 3 hours ago

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

Updated about 3 hours ago

Did this page help you?