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

# Update Note

> Update a personal note (partial — send only fields to change).

Only notes owned by the API key's creator are writable; the shared corpus is
read-only over /v1, and anything else 404s. `content_markdown` is decoded back into
the note's stored sections, and a section block this server does not recognise
round-trips untouched. When both fields are sent, `title` wins over any title in the
markdown front matter.

This endpoint never creates a note — `topic_notes` has no uniqueness constraint, and
duplicate rows break the app's `.maybeSingle()` reads.



## OpenAPI

````yaml /openapi.json put /v1/notes/{note_id}
openapi: 3.1.0
info:
  title: ClassQuill Public API
  description: >-
    REST API for ClassQuill tutoring organisations. Pipe your sessions,
    invoices, payments, tutor earnings, students, and more into your own tools.
    Most endpoints are reads; a focused set of writes (each gated by a *:write
    scope) create or update data, including creating student/tutor/parent
    accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=ei_live_...

    Mint keys in the ClassQuill app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/notes/{note_id}:
    put:
      tags:
        - General
      summary: Update Note
      description: >-
        Update a personal note (partial — send only fields to change).


        Only notes owned by the API key's creator are writable; the shared
        corpus is

        read-only over /v1, and anything else 404s. `content_markdown` is
        decoded back into

        the note's stored sections, and a section block this server does not
        recognise

        round-trips untouched. When both fields are sent, `title` wins over any
        title in the

        markdown front matter.


        This endpoint never creates a note — `topic_notes` has no uniqueness
        constraint, and

        duplicate rows break the app's `.maybeSingle()` reads.
      operationId: update_note_v1_notes__note_id__put
      parameters:
        - name: note_id
          in: path
          required: true
          schema:
            type: string
            title: Note Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            Not found — the record doesn't exist or belongs to another
            organisation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation error — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limit exceeded — honour Retry-After and the RateLimit-*
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    NoteUpdate:
      properties:
        title:
          anyOf:
            - type: string
              maxLength: 300
              minLength: 1
            - type: 'null'
          title: Title
        content_markdown:
          anyOf:
            - type: string
              maxLength: 200000
            - type: 'null'
          title: Content Markdown
      additionalProperties: false
      type: object
      title: NoteUpdate
      description: >-
        PUT /v1/notes/{id} → topic_notes. Only personal notes are writable;
        shared notes

        are read-only over /v1. `content_markdown` is decoded back into the
        note's stored

        sections — an unrecognised section block round-trips untouched. When
        both fields are

        sent, `title` wins over any title in the markdown front matter.
    Note:
      properties:
        id:
          type: string
          title: Id
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        content_markdown:
          anyOf:
            - type: string
            - type: 'null'
          title: Content Markdown
        topic_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Topic Id
        scope:
          anyOf:
            - type: string
              enum:
                - shared
                - personal
            - type: 'null'
          title: Scope
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
      title: Note
      description: >-
        A topic note. `content_markdown` is the note's full body as a markdown
        document

        (see `api.notes_codec`) — it is populated on GET /v1/notes/{id} and is
        **null in

        list responses**, which carry metadata only.


        `scope` is derived: 'shared' for the published global corpus, 'personal'
        for a

        note owned by the API key's creator. The physical note_type vocabulary
        and the

        structured_content JSONB shape are deliberately not exposed.
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: >-
            Stable machine-readable error code: bad_request, unauthorized,
            forbidden, not_found, conflict, validation_error, rate_limited, or
            internal_error.
          examples:
            - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
            - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
            - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: >-
            Error-specific context. 422 carries the field errors under `errors`;
            429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
        - code
        - message
        - status
      title: ApiErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=ei_live_...`

````