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

# Mark notification read

> **Auth:** organization API key with `write` scope, or a signed-in user.



## OpenAPI

````yaml https://cp.xenovia.io/openapi.json patch /api/v1/alert-notifications/{notification_id}/read
openapi: 3.1.0
info:
  title: Xenovia Control Plane API
  version: 1.0.0
  description: >-
    Management API for proxies, providers, policies, telemetry, alerts and
    organization settings.
servers:
  - url: https://cp.xenovia.io
    description: Production
security:
  - BearerAuth: []
paths:
  /api/v1/alert-notifications/{notification_id}/read:
    patch:
      tags:
        - alerts
      summary: Mark notification read
      description: '**Auth:** organization API key with `write` scope, or a signed-in user.'
      operationId: >-
        mark_notification_read_route_api_v1_alert_notifications__notification_id__read_patch
      parameters:
        - name: notification_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Notification Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertNotificationRead'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    AlertNotificationRead:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        org_id:
          type: string
          format: uuid
          title: Org Id
        rule_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Rule Id
        proxy_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Proxy Id
        alert_event_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Alert Event Id
        title:
          type: string
          title: Title
        body:
          type: string
          title: Body
        severity:
          type: string
          title: Severity
        read:
          type: boolean
          title: Read
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - org_id
        - rule_id
        - proxy_id
        - alert_event_id
        - title
        - body
        - severity
        - read
        - created_at
      title: AlertNotificationRead
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer token: an organization API key (`ak_…`) created under Settings →
        API Keys, or a dashboard user session token. Proxy keys (`xe_…`) are not
        accepted here. Endpoints marked as user-only in their description reject
        organization keys with `403`.

````