Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Candidate

candidate.createNote

Creates a note on a candidate.

Requires the candidatesWrite permission.

post/candidate.createNote

Request body

candidateIdstring uuid required

The id of the candidate

sendNotificationsboolean nullable

Whether or not users who are subscribed to the candidate should be notified that the note was posted. Default is false.

isPrivateboolean nullable

Whether the note should be marked as private. Private notes require "Allow access to non-offer private fields?" API key permission to create and view. Default is false.

createdAtstring nullable

An ISO date string to set the note's createdAt timestamp

Example request

{
  "candidateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "createdAt": "2022-08-12T20:29:56.964Z"
}

Response

Responses from the candidate.createNote endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "5fa61e0b-3c4d-4e5f-9a0b-1c2d3e4f5a6b",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "isPrivate": false,
    "content": "Strong candidate, very interested in the company",
    "author": {
      "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
      "firstName": "George",
      "lastName": "Bluth",
      "email": "george@bluth.example"
    }
  }
}