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

# Update a note

> Replace a note's content as plain text or markdown.



## OpenAPI

````yaml patch /notes/{note_id}/
openapi: 3.0.1
info:
  title: Standard Metrics API Documentation
  description: >-
    Welcome to Standard Metric's API docs!


    To use our API you will need to make an OAuth appliction (or use an existing
    one) in the developer settings tab on your settings page and then exchange
    your client id and secret for an access token (via the `/o/token/` endpoint.
    This token can then be sent in the `Authorization` header to authenticate
    your requests to our api. See below for an example.


    All endpoints are paginated and will return a maximum of 100 results per
    page. See the endpoints below and example responses for more details on
    pagination parameters. A maximum of 120 requests per minute can be made to
    our API.


    Authentication example (with python):

    ```>>> import base64

    >>> import base64

    >>> client_id = "YOUR_CLIENT_ID"

    >>> client_secret = "YOUR_CLIENT_SECRET"

    >>> credential = f"{client_id}:{client_secret}"

    >>> base64.b64encode(credential.encode("utf-8"))

    b'ENCODED_CREDENTIAL'


    You can now exchange this credential for an access token, eg:


    curl -X POST \
        -H "Authorization: Basic ENCODED_CREDENTIAL" \
        -H "Cache-Control: no-cache" \
        -H "Content-Type: application/x-www-form-urlencoded" \
        "https://api.standardmetrics.io/o/token/" \
        -d "grant_type=client_credentials"

    You will receive the following response:


    {
        "access_token": "YOUR_ACCESS_TOKEN",
        "expires_in": 36000,
        "token_type": "Bearer",
        "scope": "read write"
    }


    Make sure not to forget to prepend "Bearer " to your access token in the
    Authorization header while making requests.
  version: '1.0'
servers:
  - url: https://api.standardmetrics.io/v1
security:
  - Bearer: []
paths:
  /notes/{note_id}/:
    patch:
      tags:
        - notes
      summary: Update a note
      description: >-
        Replace a note's content using the note ID returned when retrieving
        notes.

        The updated note is returned in markdown format.


        **Notes:**

        - `note` is required and must be a non-empty string.

        - `format` defaults to `plain`. Pass `markdown` to render rich text,
          with the same formatting support as note creation.
        - Empty, null, or omitted content and changes to author/company return
        400,
          leaving the note unchanged. Use DELETE to remove a note.
        - Invalid IDs return 400; missing or inaccessible notes return 404.

        - Insufficient edit access or authorship returns 403.


        **Permissions:**

        - User must be authenticated via OAuth.

        - User must have access to the company.

        - User must have ADMIN or EDITOR role.

        - User must be the note's author. Firm admins cannot edit another
        author's note.
      operationId: notes_partial_update
      parameters:
        - name: note_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortfolioCompanyNoteAPIUpdate'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortfolioCompanyNoteAPI'
components:
  schemas:
    PortfolioCompanyNoteAPIUpdate:
      required:
        - note
      type: object
      properties:
        note:
          title: Note
          type: string
          description: Required non-empty replacement text. Use DELETE to remove the note.
        format:
          title: Format
          type: string
          default: plain
          enum:
            - plain
            - markdown
      additionalProperties: false
    PortfolioCompanyNoteAPI:
      required:
        - author_id
        - note
      type: object
      properties:
        note:
          title: Note
          type: string
        author:
          title: Author
          minLength: 1
          type: string
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        email:
          title: Email
          minLength: 1
          type: string
          readOnly: true
        id:
          title: Id
          type: string
          readOnly: true
        author_id:
          title: Author id
          type: string
        company_id:
          title: Company id
          type: string
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Your valid bearer token. All Auth tokens persist for all requests. Make
        sure to replace Client Credential `Basic` tokens with `Bearer` tokens
        after retrieving your bearer token. Go to the API Reference/Setup, User
        Guides/Initial Setup, or API Reference/Get API Access Token page to get
        your token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.