> ## 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 notification as read

> Mark a single notification by id as read and return the updated notification. Requires the WRITE_NOTIFICATIONS scope.

Marks one notification (by id) as read and returns it. Only notifications belonging to the merchant on the bound store can be marked; an unknown id returns 404.


## OpenAPI

````yaml PATCH /notifications/{id}/read
openapi: 3.1.0
info:
  title: Salesive Apps API — Messaging
  version: 1.0.0
  description: >-
    Read the merchant's notifications and send in-app notifications and
    templated emails on behalf of an installed third-party app. 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:
  /notifications/{id}/read:
    patch:
      tags:
        - Notifications
      summary: Mark a notification as read
      description: >-
        Mark a single notification (by id) as read and return the updated
        notification. Only notifications belonging to the merchant on the store
        bound to the app token can be marked; an unknown id returns 404. The
        store is bound to the app token server-side from the installation —
        never send a shop id. Requires the `WRITE_NOTIFICATIONS` scope.
      operationId: markNotificationRead
      parameters:
        - name: id
          in: path
          required: true
          description: The id of the notification to mark as read.
          schema:
            type: string
      responses:
        '200':
          description: The updated notification.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Notification'
              example:
                status: 200
                success: true
                message: Notification marked as read
                data:
                  _id: 66b3f0a1c2d4e5f600112233
                  user: 66a1b2c3d4e5f60011223344
                  shop: 66a0a1b2c3d4e5f600112200
                  title: New order received
                  message: 'Order #1042 was just placed for $59.99.'
                  type: order
                  read: true
                  readAt: '2026-06-28T09:45:00.000Z'
                  data:
                    orderId: 66b3efaa11223344556677
                  createdAt: '2026-06-28T09:14:00.000Z'
                  updatedAt: '2026-06-28T09:45:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  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.
    Notification:
      type: object
      description: A single in-app notification belonging to the merchant on the store.
      properties:
        _id:
          type: string
          description: The notification id (Mongo ObjectId).
        user:
          type: string
          description: The recipient merchant's user id.
        shop:
          type: string
          description: The store id (bound server-side).
        title:
          type: string
          description: Short heading.
        message:
          type: string
          description: Body text.
        type:
          type: string
          description: Category (e.g. "info", "order", "urgent").
        url:
          type: string
          description: Optional deep-link URL.
        read:
          type: boolean
          description: Whether the notification has been read.
        readAt:
          type: string
          format: date-time
          description: When the notification was marked read, if applicable.
        data:
          type: object
          additionalProperties: true
          description: Arbitrary key/value metadata attached to the notification.
        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 notification does not exist or does not belong to the merchant on
        the installation's store.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 404
            success: false
            message: Notification 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.

````