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

# Update notification settings

> Updates the notification settings for the authenticated user in a workspace.



## OpenAPI

````yaml /api-reference/openapi.json patch /workspaces/{workspaceSlug}/notifications/
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document processing and annotation platform
  description: >-
    Nvisy provides intelligent document processing, annotation, and analysis
    capabilities. This API enables document upload, OCR processing, embedding
    generation, and semantic search across your document collections.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Proprietary
    url: https://nvisy.com/license
  version: 0.1.0
servers: []
security: []
tags:
  - name: Accounts
    description: Account management and profile operations
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Files
    description: File upload, download, and management
  - name: Members
    description: Workspace member management
  - name: Invites
    description: Workspace invitation handling
  - name: API Tokens
    description: API token management
  - name: Connections
    description: External provider connections
  - name: Pipelines
    description: Redaction pipeline configuration
  - name: Pipeline Runs
    description: Pipeline run execution and review
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
  - name: Health
    description: Service health checks
paths:
  /workspaces/{workspaceSlug}/notifications/:
    patch:
      tags:
        - Workspaces
      summary: Update notification settings
      description: >-
        Updates the notification settings for the authenticated user in a
        workspace.
      parameters:
        - in: path
          name: workspaceSlug
          description: URL-safe workspace identifier.
          required: true
          schema:
            description: URL-safe workspace identifier.
            type: string
          style: simple
      requestBody:
        description: Request payload for updating notification settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateNotificationSettings'
        required: true
      responses:
        '200':
          description: Response for notification settings within a workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettings'
        '400':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: >-
            HTTP error response representation with security-conscious design.


            This struct contains all the information needed to serialize an
            error

            response, including the error name, message, HTTP status code,
            resource

            information, and user-friendly messages.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '415':
          description: 'Expected request with `Content-Type: application/json`'
          content:
            text/plain:
              schema:
                type: string
        '422':
          description: Failed to deserialize the JSON body into the target type
          content:
            text/plain:
              schema:
                type: string
      security:
        - BearerAuth: []
components:
  schemas:
    UpdateNotificationSettings:
      description: Request payload for updating notification settings.
      type: object
      properties:
        notificationEventsApp:
          description: Notification events to receive in-app.
          type: array
          items:
            $ref: '#/components/schemas/NotificationEvent'
        notificationEventsEmail:
          description: Notification events to receive via email.
          type: array
          items:
            $ref: '#/components/schemas/NotificationEvent'
        notifyViaEmail:
          description: Whether to send email notifications.
          type: boolean
    NotificationSettings:
      description: Response for notification settings within a workspace.
      type: object
      properties:
        notificationEventsApp:
          description: Notification events to receive in-app.
          type: array
          items:
            $ref: '#/components/schemas/NotificationEvent'
        notificationEventsEmail:
          description: Notification events to receive via email.
          type: array
          items:
            $ref: '#/components/schemas/NotificationEvent'
        notifyViaEmail:
          description: Whether to send email notifications.
          type: boolean
      required:
        - notifyViaEmail
        - notificationEventsApp
        - notificationEventsEmail
    ErrorResponse:
      description: |-
        HTTP error response representation with security-conscious design.

        This struct contains all the information needed to serialize an error
        response, including the error name, message, HTTP status code, resource
        information, and user-friendly messages.
      type: object
      properties:
        message:
          description: User-friendly error message safe for client display
          type: string
        name:
          description: The error name/type identifier
          type: string
        resource:
          description: The resource that the error relates to (optional, set by handler)
          type: string
        suggestion:
          description: Helpful suggestion for resolving the error (optional)
          type: string
        validation:
          description: Validation error details for field-specific errors
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorDetail'
      required:
        - name
        - message
    NotificationEvent:
      description: >-
        Defines the type of notification event sent to a user.


        This enumeration corresponds to the `NOTIFICATION_EVENT` PostgreSQL enum
        and

        is used for member, connection-sync, pipeline-run, and system
        notifications.

        The values mirror the [`WebhookEvent`](super::WebhookEvent) naming for
        the

        events the two channels share.
      oneOf:
        - description: User was invited to a workspace
          type: string
          const: member.invited
        - description: A new member joined a workspace
          type: string
          const: member.joined
        - description: A connection sync completed
          type: string
          const: connection.sync.completed
        - description: A connection sync failed
          type: string
          const: connection.sync.failed
        - description: A pipeline run finished detection and is awaiting review
          type: string
          const: pipeline.run.analyzed
        - description: A pipeline run completed (redaction produced)
          type: string
          const: pipeline.run.completed
        - description: A pipeline run failed
          type: string
          const: pipeline.run.failed
        - description: System-wide announcement
          type: string
          const: system.announcement
        - description: System report generated
          type: string
          const: system.report
    ValidationErrorDetail:
      description: Validation error details for field-specific errors.
      type: object
      properties:
        code:
          description: Error code for the validation failure
          type: string
        field:
          description: Field name that failed validation
          type: string
        message:
          description: Human-readable error message
          type: string
        params:
          description: Additional parameters related to the validation error
          type: object
          additionalProperties: true
      required:
        - field
        - code
        - message

````