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. */
            email: boolean;
            /** @description Indicates whether the user has opted to receive notifications via SMS. */
            sms: boolean;
            /** @description Indicates whether the user has opted to receive notifications via WhatsApp. */
            whatsapp: boolean;
        };
        /**
         * NotificationPreferences
         * @description Set channel preferences for each type of
         */
}

OpenAPI Schema

json
{
  "title": "NotificationChannelPreferences",
  "description": "Set specific channel preferences",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/NotificationChannelPreferences",
    "description": "API reference for the NotificationChannelPreferences schema"
  },
  "required": [
    "email",
    "sms",
    "whatsapp"
  ],
  "properties": {
    "email": {
      "description": "Indicates whether the user has opted to receive notifications via email.",
      "type": "boolean"
    },
    "sms": {
      "description": "Indicates whether the user has opted to receive notifications via SMS.",
      "type": "boolean"
    },
    "whatsapp": {
      "description": "Indicates whether the user has opted to receive notifications via WhatsApp.",
      "type": "boolean"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: