---
title: "Update Note"
method: PATCH
path: "/api/v1/clients/{entity_id}/notes/{note_id}/"
tags: ["notes", "notes"]
---

# Update Note

`PATCH /api/v1/clients/{entity_id}/notes/{note_id}/`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/clients/{entity_id}/notes/{note_id}/`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

## Path parameters

- `entity_id` integer, required
- `note_id` integer, required

## Request body

- NoteUpdate
  - `title` string, nullable
  - `body` string, required

## Response `200`

Successful Response

- NoteResponse
  - `id` integer, required
  - `entity_type` string, required
  - `entity_id` integer, required
  - `title` string, nullable
  - `body` string, required
  - `user_id` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)