> ## Documentation Index
> Fetch the complete documentation index at: https://docs.slant.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a note

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



## OpenAPI

````yaml /api-reference/openapi.yaml patch /v1/households/{household_id}/notes/{id}
openapi: 3.0.1
info:
  title: Slant Public API V1
  version: v1
  description: Public API for creating and managing resources in Slant
  contact:
    name: Slant API Support
    email: api@slant.com
servers:
  - url: https://api.slant.app
security:
  - bearer: []
paths:
  /v1/households/{household_id}/notes/{id}:
    parameters:
      - name: household_id
        in: path
        description: The household ID
        required: true
        example: household123xyz
        schema:
          type: string
    patch:
      tags:
        - Notes
      summary: Update a note
      description: >-
        Update a note. Only provided fields change; tag_ids and references
        replace their complete sets.
      parameters:
        - name: id
          in: path
          description: The note ID
          required: true
          example: 123e4567-e89b-12d3-a456-426614174000
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
          description: >-
            Unique key to ensure idempotent request handling. If a request with
            the same key was already processed, the original response will be
            returned.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - note
              properties:
                note:
                  type: object
                  properties:
                    content:
                      type: string
                      description: Plaintext or markdown content. HTML tags are stripped.
                      example: Important meeting notes from client discussion
                    pinned:
                      type: boolean
                      description: Whether the note is pinned
                      example: false
                    tag_ids:
                      type: array
                      description: >-
                        Complete set of note label IDs. Pass an empty array to
                        clear all labels.
                      items:
                        type: string
                    references:
                      type: array
                      description: >-
                        Complete set of referenced records. Pass an empty array
                        to clear all references.
                      items:
                        type: object
                        required:
                          - id
                          - type
                        properties:
                          id:
                            type: string
                            description: The referenced record ID
                          type:
                            type: string
                            enum:
                              - Business
                              - Client
                              - Contact
                              - Household
                              - Person
                              - Prospect
                              - Trust
                              - User
                            description: The referenced record type
        required: true
      responses:
        '200':
          description: note updated
          content:
            application/json:
              schema:
                type: object
                required:
                  - id
                  - content
                  - pinned
                  - tag_ids
                  - references
                  - book_id
                  - created_at
                  - updated_at
                properties:
                  id:
                    type: string
                    description: The note ID
                    example: abc123xyz
                  content:
                    type: string
                    description: The plaintext content of the note
                    example: Meeting notes from client discussion
                  pinned:
                    type: boolean
                    description: Whether the note is pinned
                    example: false
                  hidden:
                    type: boolean
                    description: Whether the note is hidden
                    example: false
                  tag_ids:
                    type: array
                    description: The complete set of label IDs applied to the note
                    items:
                      type: string
                  references:
                    type: array
                    description: Records referenced by the note
                    items:
                      type: object
                      required:
                        - id
                        - type
                        - label
                      properties:
                        id:
                          type: string
                          description: The referenced record ID
                        type:
                          type: string
                          enum:
                            - Business
                            - Client
                            - Contact
                            - Household
                            - Person
                            - Prospect
                            - Trust
                            - User
                          description: The referenced record type
                        label:
                          type: string
                          description: The server-derived display label
                  book_id:
                    type: string
                    description: The book ID
                    example: book123xyz
                  household_id:
                    type: string
                    description: The household ID
                    example: household123xyz
                    nullable: true
                  created_by_id:
                    type: string
                    description: The ID of the user who created the note
                    example: user123xyz
                    nullable: true
                  created_at:
                    type: string
                    format: date-time
                    description: When the note was created
                  updated_at:
                    type: string
                    format: date-time
                    description: When the note was last updated
        '400':
          description: bad request - invalid JSON
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - invalid_json
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '401':
          description: unauthorized - missing or invalid token
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - token_missing
                      - token_invalid
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '403':
          description: forbidden
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - record_not_found
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth 2.0 Bearer Token from Clerk authentication

````