---
title: "POST /notes"
method: POST
path: "/notes"
tags: ["Notes"]
---

# POST /notes

`POST /notes`

Creates a new note on an entity (job, customer, quote, etc.).

## Request body

- CreateNotePayload
  - `text` string, required — The body text of the note
  - `entityName` union, required — The type of entity this note belongs to
    - 'job'
    - 'customer'
    - 'customer_invoice'
    - 'quote'
    - 'site'
    - 'task'
    - 'enquiry'
    - 'works_order'
  - `entityId` number, required — The ID of the entity this note belongs to
  - `parentId` number, nullable — Parent note ID for a reply. Omit or set null for top-level notes.
  - `isPinned` boolean — Pin the note on creation. Defaults to false.

## Response `201`

Resource created successfully

- CreateNoteResponse
  - `result` string, required
  - `data` NoteReply, required
    - `id` number, required
    - `companyId` number, required
    - `entityId` number, required
    - `entityName` 'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE', required
    - `text` string, required
    - `createdById` number, required
    - `createdAt` string, required
    - `isPinned` boolean, required
    - `parentId` number, nullable, required
    - `links` Links[], required
      - `href` string, required
      - `rel` string, required
      - `type` 'GET' | 'POST' | 'PUT' | 'PATCH', required

## Other responses

- `4XX` — Client Request Errors
- `5XX` — Server Errors

---

[API](https://skmtc.dev/fergus/apis/fergus-api.md) · [All operations](https://skmtc.dev/fergus/apis/fergus-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fergus/fergus-api/revisions/ae0b6a769e23/schema)