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

# Update an internal note (author only)



## OpenAPI

````yaml /openapi.json patch /policies/{policyId}/internal-notes/{noteId}
openapi: 3.0.0
info:
  title: Korint API
  description: >-
    Quoting, policy issuance, billing, claims, documents and compliance for
    insurance distribution.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.korint.io
    description: Production
  - url: https://api.sandbox.korint.io
    description: Sandbox
security:
  - oauth2: []
  - bearerAuth: []
tags: []
paths:
  /policies/{policyId}/internal-notes/{noteId}:
    patch:
      tags:
        - internal-notes
      summary: Update an internal note (author only)
      operationId: InternalNotesController_update
      parameters:
        - name: tenant
          in: header
          required: true
          description: Your tenant identifier. Requests without it are rejected.
          schema:
            type: string
        - name: policyId
          required: true
          in: path
          schema:
            pattern: >-
              ^policy(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
            type: string
        - name: noteId
          required: true
          in: path
          schema:
            pattern: >-
              ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInternalNoteInputBody'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateInternalNoteOutput'
        '403':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/InternalNoteNotAuthorErrorDto'
              examples:
                INTERNAL_NOTE_NOT_AUTHOR:
                  value:
                    code: INTERNAL_NOTE_NOT_AUTHOR
                    message: Only the author can perform this action on note {noteId}
                    details: {}
          description: ''
        '404':
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/CommentNotFoundErrorDto'
              examples:
                COMMENT_NOT_FOUND:
                  value:
                    code: COMMENT_NOT_FOUND
                    message: Comment {id} not found
                    details: {}
          description: ''
components:
  schemas:
    UpdateInternalNoteInputBody:
      type: object
      properties:
        content:
          type: string
          maxLength: 5000
      required:
        - content
    UpdateInternalNoteOutput:
      type: object
      properties:
        id:
          pattern: >-
            ^comment(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
          type: string
          description: Id of the internal note (semantic comment id)
        policyId:
          type: string
          description: Id of the policy the note is attached to
        content:
          type: string
          description: Note content
          maxLength: 5000
        author:
          $ref: '#/components/schemas/InternalNoteAuthorDto'
        createdAt:
          format: date-time
          type: string
          description: Date and time when the note was created
        updatedAt:
          format: date-time
          type: string
          description: Date and time when the note was last updated
        deletedAt:
          format: date-time
          type: string
          description: Date and time when the note was soft-deleted
          nullable: true
        isOwn:
          type: boolean
          description: Whether the calling user authored this note
      required:
        - id
        - policyId
        - content
        - author
        - createdAt
        - updatedAt
        - isOwn
    InternalNoteNotAuthorErrorDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - INTERNAL_NOTE_NOT_AUTHOR
        message:
          type: string
          example: Only the author can perform this action on note {noteId}
        details:
          $ref: '#/components/schemas/InternalNoteNotAuthorDetailsDto'
      required:
        - code
        - message
        - details
    CommentNotFoundErrorDto:
      type: object
      properties:
        code:
          type: string
          enum:
            - COMMENT_NOT_FOUND
        message:
          type: string
          example: Comment {id} not found
        details:
          $ref: '#/components/schemas/CommentNotFoundDetailsDto'
      required:
        - code
        - message
        - details
    InternalNoteAuthorDto:
      type: object
      properties:
        userId:
          type: string
          description: Cognito sub of the author
        displayName:
          type: string
          description: Author display name resolved from the Broker row
          nullable: true
        businessRole:
          type: string
          description: Author business role
          nullable: true
      required:
        - userId
    InternalNoteNotAuthorDetailsDto:
      type: object
      properties:
        noteId:
          type: string
        authorUserId:
          type: string
        callerUserId:
          type: string
      required:
        - noteId
        - authorUserId
        - callerUserId
    CommentNotFoundDetailsDto:
      type: object
      properties:
        id:
          type: string
      required:
        - id
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://korint-tenant.auth.eu-west-3.amazoncognito.com/oauth2/token
          scopes:
            korint.io/account: Read account information
            korint.io/analytics: Access analytics endpoints
            korint.io/assets: Access asset endpoints
            korint.io/billing: Access billing endpoints
            korint.io/branches: Access branch endpoints
            korint.io/broker: Access broker endpoints
            korint.io/claims: Access claim endpoints
            korint.io/comments: Access comment endpoints
            korint.io/customers: Access customer endpoints
            korint.io/derogations: Access derogation endpoints
            korint.io/documents: Access document endpoints
            korint.io/external: Access external lookup endpoints
            korint.io/external-claims: Declare claims from an external system
            korint.io/internal-notes: Access internal note endpoints
            korint.io/invitations: Access invitation endpoints
            korint.io/payments: Access payment endpoints
            korint.io/permissions: Access permission management endpoints
            korint.io/policies: Access policy endpoints
            korint.io/quotes: Access quote endpoints
            korint.io/reportings: Access reporting endpoints
            korint.io/signature: Access signature endpoints
      description: >-
        Machine-to-machine clients use the OAuth 2.0 client credentials grant.
        Each tenant has its own authorization server: in the token URL below,
        replace `tenant` with your tenant identifier.
    bearerAuth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: An access token obtained from your tenant authorization server.

````