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

# Update a notification preference (PATCH)

> Identical to the PUT operation. Turns one type of notification on or off for a user, such as the newsletter



## OpenAPI

````yaml https://api.zapnito.com/api/docs/v1/swagger.json patch /api/v1/users/{user_email}/notification_preferences
openapi: 3.0.1
info:
  title: API V1
  version: v1
  description: Zapnito API Documentation
servers:
  - url: https://{host}
    description: Your community domain
    variables:
      host:
        default: your-community.com
        description: Your community domain, for example your-community.com
security: []
tags:
  - name: Health Check
    description: Check that the API is reachable and that your API key is valid
  - name: Identity
    description: Find out which community your API key belongs to
  - name: Users
    description: >-
      Look up the people in your community, update their profile and choose
      which notifications they receive
  - name: Organisations
    description: >-
      Create and update the organisations in your community and manage who
      belongs to them
  - name: Groups
    description: Create groups and manage which users belong to them
  - name: Invitations
    description: Invite people to join your community
  - name: Posts
    description: Create, read and update posts on behalf of your community members
  - name: Contents
    description: >-
      Read the published content of your community and publish, schedule or
      unpublish it
  - name: Channels
    description: List the channels in your community and the content published in each
  - name: Rooms
    description: Create and read the rooms where your community members meet
  - name: Tags
    description: Create tags and apply them to content
  - name: Badges
    description: Create badges and award them to content or to users
  - name: Custom Fields
    description: Read the custom profile fields your community asks its members to fill in
  - name: Third-Party Resources
    description: >-
      Link to resources hosted outside your community so they appear alongside
      your content
  - name: Rest Hooks
    description: >-
      Subscribe a URL to events in your community, so you are told when they
      happen
paths:
  /api/v1/users/{user_email}/notification_preferences:
    parameters:
      - name: user_email
        in: path
        required: true
        description: The user's email address
        schema:
          type: string
    patch:
      tags:
        - Users
      summary: Update a notification preference (PATCH)
      description: >-
        Identical to the PUT operation. Turns one type of notification on or off
        for a user, such as the newsletter
      operationId: patchNotificationPreference
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferenceUpdateRequest'
        required: true
        description: Preference payload wrapped in a notification_preference object
      responses:
        '200':
          description: The notification preference was saved
          content:
            application/json:
              schema:
                type: object
                properties:
                  notification_preference:
                    $ref: '#/components/schemas/NotificationPreference'
                required:
                  - notification_preference
        '400':
          description: >-
            The notification_preference object or its notification_type is
            missing. The response has no body
        '401':
          description: >-
            The API key is missing or invalid. The response body is the text
            `HTTP Token: Access denied.`
        '422':
          description: The request failed validation
          content:
            application/json:
              examples:
                error:
                  value:
                    errors:
                      notification_type:
                        - is not included in the list
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                    example:
                      notification_type:
                        - is not included in the list
                required:
                  - errors
      security:
        - tokenAuth: []
components:
  schemas:
    NotificationPreferenceUpdateRequest:
      type: object
      properties:
        notification_preference:
          type: object
          properties:
            notification_type:
              type: string
              example: newsletter
              description: >-
                The type of notification to change, for example newsletter or
                someone_follows_you
            notification_choice:
              type: boolean
              example: false
              description: Whether the user receives this type of notification
          required:
            - notification_type
      required:
        - notification_preference
    NotificationPreference:
      type: object
      properties:
        id:
          type: integer
          example: 1
        tenant_user_id:
          type: integer
          example: 1
          description: Identifier of the user's membership of the community
        notification_type:
          type: string
          example: newsletter
        notification_choice:
          type: boolean
          example: false
          description: Whether the user receives this type of notification
      required:
        - id
        - tenant_user_id
        - notification_type
        - notification_choice
  securitySchemes:
    tokenAuth:
      type: apiKey
      name: Authorization
      in: header
      description: >-
        API authentication using your community API secret. The value below is
        sent as the Authorization header verbatim, so paste the whole header
        value including the prefix: Token token=<api-key>
      x-default: Token token=<api-key>

````

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