Create a candidate note

post

https://api.join.com/v3/candidates/{candidateId}/notes

Creates a note on a candidate. The note has no author and is always visible to your whole company. Content is limited to 2500 characters and cannot be changed afterwards. A candidate holds at most 50 notes; one already at or over that limit takes no new note until it is back under it (note_limit_reached).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The note is created

400The request could not be processed: an unsupported API version, or an unparseable JSON body.

401Authentication failed. Either the Authorization: Bearer header is missing (authentication_required), or the presented token is malformed, unknown, revoked, or belongs to a company that no longer has API access (token_invalid).

404No candidate with this id exists within the caller’s company. Ids belonging to other companies or to deleted candidates are reported the same way.

422The request body failed validation, or the candidate already holds the maximum number of notes (note_limit_reached).

429The token exceeded its sustained (600/60s) or burst (100/10s) request quota. Retry after the number of seconds in Retry-After.

500An unexpected error occurred on JOIN’s side. The request may be retried.