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

# Mark a note as read

> Mark a note as read. Requires the WRITE_NOTES scope.

Marks the note as read; no request body is needed. The store is bound to your app token server-side — never send a shop id.


## OpenAPI

````yaml PUT /notes/{id}/mark-read
openapi: 3.1.0
info:
  title: Salesive Apps API — Productivity
  version: 1.0.0
  description: >-
    Manage the store's productivity resources from an installed third-party app:
    tasks (with recurrence and per-occurrence responses), notes, custom
    storefront scripts/tracking, and storefront comment replies. Every endpoint
    authenticates with an installed-app access token (prefix `app_`) and
    requires a specific OAuth scope. The target store is bound to the token
    server-side from the installation — never send a shop id.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /notes/{id}/mark-read:
    put:
      tags:
        - Notes
      summary: Mark a note as read
      description: >-
        Marks a note as read. No request body is needed. Authenticate with
        `Authorization: Bearer app_<token>`. Returns 404 if the note does not
        exist or does not belong to the installation's store. Requires the
        `WRITE_NOTES` scope and returns 403 if missing. The store is bound to
        the app token server-side from the installation — never send a shop id.
      operationId: markNoteRead
      parameters:
        - $ref: '#/components/parameters/NoteId'
      responses:
        '200':
          description: The note was marked read.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Note'
              example:
                status: 200
                success: true
                message: Note marked as read
                data:
                  _id: 66d1f0a3c2d4e5f6a7b8c9d0
                  title: Supplier contacts
                  body: Call Acme Co. for Q3 pricing.
                  shop: 6680aabbccddeeff00112200
                  user: 66a0c1d2e3f4a5b6c7d8e9f0
                  createdAt: '2026-06-21T10:30:00.000Z'
                  updatedAt: '2026-06-21T12:00:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    NoteId:
      name: id
      in: path
      required: true
      description: The note's id (Mongo ObjectId).
      schema:
        type: string
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    Note:
      type: object
      description: A note belonging to the store.
      properties:
        _id:
          type: string
        title:
          type: string
        body:
          type: string
        shop:
          type: string
          description: The store id (bound server-side).
        user:
          type: string
          description: User id of the author.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
    NotFound:
      description: >-
        The resource does not exist or does not belong to the installation's
        store.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 404
            success: false
            message: Resource not found
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side — never send a shop
        id.

````