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

# Update a note

`PATCH /v1/households/{household_id}/notes/{id}`

Update a note. Only provided fields change; tag_ids and references replace their complete sets.

## Path parameters

- `id` string, required

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `note` object, required
    - `content` string — Plaintext or markdown content. HTML tags are stripped.
    - `pinned` boolean — Whether the note is pinned
    - `tag_ids` string[] — Complete set of note label IDs. Pass an empty array to clear all labels.
    - `references` object[] — Complete set of referenced records. Pass an empty array to clear all references.
      - `id` string, required — The referenced record ID
      - `type` 'Business' | 'Client' | 'Contact' | 'Household' | 'Person' | 'Prospect' | 'Trust' | 'User', required — The referenced record type

## Response `200`

note updated

- object
  - `id` string, required — The note ID
  - `content` string, required — The plaintext content of the note
  - `pinned` boolean, required — Whether the note is pinned
  - `hidden` boolean — Whether the note is hidden
  - `tag_ids` string[], required — The complete set of label IDs applied to the note
  - `references` object[], required — Records referenced by the note
    - `id` string, required — The referenced record ID
    - `type` 'Business' | 'Client' | 'Contact' | 'Household' | 'Person' | 'Prospect' | 'Trust' | 'User', required — The referenced record type
    - `label` string, required — The server-derived display label
  - `book_id` string, required — The book ID
  - `household_id` string, nullable — The household ID
  - `created_by_id` string, nullable — The ID of the user who created the note
  - `created_at` string, date-time, required — When the note was created
  - `updated_at` string, date-time, required — When the note was last updated

## Other responses

- `400` — bad request - invalid JSON
- `401` — unauthorized - missing or invalid token
- `403` — forbidden
- `404` — not found

---

[API](https://skmtc.net/slant/apis/slant-public-api-v1.md) · [All operations](https://skmtc.net/slant/apis/slant-public-api-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/slant/slant-public-api-v1/revisions/b56e0d137554/schema)