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

# Update a note

`PATCH /v1/notes/{noteId}`

Updates the details of a single note (required scope notes:write)

## Path parameters

- `noteId` integer, required

## Headers

- `Customer-Id` integer, required

## Request body

- UpdateNoteModel — Update note model
  - `typeId` integer — The unique identifier of the note type definition associated to this note<br/><br/>Optional: Omit to retain current value
  - `subject` string — The subject of the note<br/><br/>Optional: Omit to retain current value
  - `ownedByUserId` integer — The unique id of the user who owns the note. Must have an active licence<br/><br/>Optional: Omit to retain current value
  - `dueAt` string, date-time, nullable — The UTC timestamp of when this note is due for completion<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `parentId` integer, nullable — The unique identifier of the parent note of this note<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `reference` string — The internal reference of the note - should usually be unique<br/><br/>Optional: Omit to retain current value
  - `status` 'open' | 'completed' | 'cancelled' — The status of the note<p>Possible values:</p><ul><li><b>open</b>: Open</li><li><b>completed</b>: Completed</li><li><b>cancelled</b>: Cancelled</li></ul>
  - `completionText` string, nullable — The completion text for the note<br/><br/>Optional: Omit to retain current value or provide null to unset
  - `description` string — The detailed textual content about the note<br/><br/>Optional: Omit to retain current value
  - `customFields` CustomFieldWriteModel[] — The collection of custom fields applied to this note<br/><br/>Optional: Omit to retain current value
    - `definitionId` integer, required — The unique identifier of the associated custom field definition
    - `value` string, nullable — The value of this custom field. If set to null, any existing value will be unset

## Response `204`

No Content

## Other responses

- `400` — Bad Request
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Content
- `500` — Internal Server Error

---

[API](https://skmtc.net/bigchange/apis/bigchange-dx.md) · [All operations](https://skmtc.net/bigchange/apis/bigchange-dx/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bigchange/bigchange-dx/revisions/916e669fc527/schema)