---
title: "candidate.createNote"
method: POST
path: "/candidate.createNote"
tags: ["Candidate"]
---

# candidate.createNote

`POST /candidate.createNote`

Creates a note on a candidate.

**Requires the [`candidatesWrite`](authentication#permissions-candidatecreatenote) permission.**

## Request body

- CandidateCreateNoteRequest
  - `candidateId` string, uuid, required — The id of the candidate
  - `note` union, required — The note to add to the candidate. Either a plain string, or an object `{ type, value }` where `type` is `text/plain` or `text/html`.
    - string
    - object
      - `type` 'text/plain' | 'text/html', required — The content type of the note
      - `value` string, required — The note's content
  - `sendNotifications` boolean, nullable — Whether or not users who are subscribed to the candidate should be notified that the note was posted. Default is false.
  - `isPrivate` boolean, 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.
  - `createdAt` string, nullable — An ISO date string to set the note's `createdAt` timestamp

## Response `200`

Responses from the candidate.createNote endpoint

- union
  - CandidateCreateNoteSuccessResponse
    - `success` true, required
    - `results` Note, required
      - `id` string, uuid, required — The unique identifier for the note
      - `createdAt` string, required — The timestamp when the note was created
      - `isPrivate` boolean, required — Whether the note is private
      - `content` string, nullable — The note's content as plain text
      - `author` Author, required
        - `id` string, uuid, required — The unique identifier for the user
        - `firstName` string, required — The user's first name
        - `lastName` string, required — The user's last name
        - `email` string, nullable — The user's email address
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/revisions/778b919dc743/schema)