---
title: "Update a note's content or pinned state"
method: PATCH
path: "/v2/notes/{note_id}"
tags: ["notes"]
---

# Update a note's content or pinned state

`PATCH /v2/notes/{note_id}`

## Request

- Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.stuut.ai/v2/notes/{note_id}`
- Auth: HTTP bearer

Update a note's content or pinned state.

## Path parameters

- `note_id` string, required

## Request body

- UpdateNoteRequest: Request body for updating a note.
  - `content` string, nullable
  - `pinned` boolean, nullable

## Response `200`

Successful Response

- Note: A user-authored note attached to exactly one supported entity.
  - `created_at` string, date-time, required
  - `modified_at` string, date-time, required
  - `id` string, required
  - `content` string, required: The content of the note.
  - `pinned` boolean, required: Whether the note is pinned and will show up first.
  - `author_id` string, nullable, required: The ID of the user who created this note.
  - `author` User, required: Lightweight user for nested relationships.
    - `created_at` string, date-time, required
    - `modified_at` string, date-time, required
    - `id` string, required
    - `email` string, required
    - `name` string, required
    - `given_name` string, required
    - `family_name` string, required
    - `profile_picture` string, nullable, required
    - `role` 'admin' | 'member' | 'manager', required
    - `object` string, required: String representing the object's type. Objects of the same type share the same value.
  - `partner_id` string, nullable, required: The ID of the partner this note belongs to.
  - `dispute_id` string, nullable, required: The ID of the dispute this note belongs to.
  - `invoice_id` string, nullable, required: The ID of the invoice this note belongs to.
  - `credit_memo_id` string, nullable, required: The ID of the credit memo this note belongs to.
  - `object` string, required: String representing the object's type. Objects of the same type share the same value.

## Other responses

- `422`: Validation Error

---

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