---
title: "PATCH /notes/{noteId}"
method: PATCH
path: "/notes/{noteId}"
tags: ["Notes"]
---

# PATCH /notes/{noteId}

`PATCH /notes/{noteId}`

Updates the text and/or pinned status of an existing note.

## Path parameters

- `noteId` number, required

## Request body

- UpdateNotePayload — At least one of `text` or `isPinned` must be provided.
  - `text` string — Updated body text for the note
  - `isPinned` boolean — Pin or unpin the note

## Response `200`

Successful Response

- UpdateNoteResponse
  - `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/b4f232a22363/schema)