v1

latestOpenAPI 3.0.12026-08-063985821.3 MB
Candidate API:Notes

Add a note

post/candidates/{candidateId}/notes

Path parameters

candidateIdinteger required

Candidate Id

Request body

typestring nullable

Note type

textstring required

Note content

applicationIdinteger[] nullable

Optional list of related job applications to link to the note

createdByIntegrationboolean

When set to true, it indicates that the note is created by integration as a part of some automation workflows, not by a specific user

referencestring nullable

Optional reference string used to identify a note or group of notes

Response

Created

noteIdstring uuid required
typestring nullable
sourcestring nullable
textstring nullable
subjectstring nullable
referencestring nullable
readonlyboolean

This note cannot be updated

createdAtstring date-time
updatedAtstring date-time nullable