---
title: "Update a mailbox note"
method: PATCH
path: "/v1/mailboxes/{id}/threads/{threadId}/notes/{noteId}"
tags: ["Mailboxes"]
---

# Update a mailbox note

`PATCH /v1/mailboxes/{id}/threads/{threadId}/notes/{noteId}`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/mailboxes/{id}/threads/{threadId}/notes/{noteId}`
- Auth: API key in header `x-api-key`

Updates the fields you name and keeps the rest. Only the note's author may.

## Path parameters

- `id` string, required
- `threadId` string, required
- `noteId` string, required

## Request body

- UpdateMailboxNotePayload
  - `body` string, nullable
  - `color` string, nullable
  - `pinned` boolean, nullable

## Response `200`

MailboxNote

- MailboxNote
  - `id` string, required
  - `author` object, required
    - `kind` 'user' | 'apiKey' | 'extension' | 'externalAgent' | 'samvaAgent' | 'system', required
    - `id` string, required
    - `displayName` string, nullable
  - `body` string, required
  - `color` string, nullable, required
  - `pinned` boolean, required
  - `createdAt` string, required
  - `updatedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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