Skip to content

NotificationChannelPreferences

Type: schema

Description

Set specific channel preferences

TypeScript Definition

typescript
NotificationChannelPreferences: {{
            /**
             * @description Indicates whether the user has opted to receive notifications via email.
             * @default true
             */
            email: boolean;
            /**
             * @description Indicates whether the user has opted to receive notifications via SMS.
             * @default true
             */
            sms: boolean;
            /**
             * @description Indicates whether the user has opted to receive notifications via WhatsApp.
             * @default true
             */
            whatsapp: boolean;
        };
        /**
         * NotificationPreferences
         * @description Set channel preferences for each type of
         */
}

OpenAPI Schema

json
{
  "description": "Set specific channel preferences",
  "type": "object",
  "properties": {
    "email": {
      "description": "Indicates whether the user has opted to receive notifications via email.",
      "type": "boolean",
      "default": true
    },
    "sms": {
      "description": "Indicates whether the user has opted to receive notifications via SMS.",
      "type": "boolean",
      "default": true
    },
    "whatsapp": {
      "description": "Indicates whether the user has opted to receive notifications via WhatsApp.",
      "type": "boolean",
      "default": true
    }
  },
  "title": "NotificationChannelPreferences"
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: