New: Kith open-sources its ATS.Read why
Skip to Content
Inputs

AddCandidateNoteInput

A note to leave.

input AddCandidateNoteInput {
  candidateId: ID!
  externalId: String
  externalSource: String
  jobId: ID
  note: String!
  requestId: String
  source: String
}

Fields

AddCandidateNoteInput.candidateId · ID! non-null scalar

The candidate.

AddCandidateNoteInput.externalId · String scalar

That system's own id for the note. Give it together with externalSource.

AddCandidateNoteInput.externalSource · String scalar

The outside system the note comes from, when it is synced from one. Give it together with externalId.

AddCandidateNoteInput.jobId · ID scalar

The job the note is about. The candidate must be on it. Left out, it is a general note about the person.

AddCandidateNoteInput.note · String! non-null scalar

The note, from 1 to 20,000 characters.

AddCandidateNoteInput.requestId · String scalar

Your own id for this request, such as a UUID made when the note was written, for a note with no external reference. Sending it again returns the note the first request wrote, with wasCreated false. Not with externalSource. 200 characters at most.

AddCandidateNoteInput.source · String scalar

How it was recorded: typed_note, voice_note, or the name of the tool writing it. note when left out.

Member Of

addCandidateNote mutation