NotificationPreferences

Type: schema

Description

Set channel preferences for each type of

TypeScript Definition

NotificationPreferences: {{
            /** @description These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities. */
            transactional: components["schemas"]["NotificationChannelPreferences"];
            /** @description These notifications aim to engage users with promotional content and enhance their overall experience with the platform. */
            promotional: components["schemas"]["NotificationChannelPreferences"];
            /** @description These notifications are often sent periodically as part of a subscription service. */
            newsletter: components["schemas"]["NotificationChannelPreferences"];
        };
        /**
         * NumberAttribute
         * @description Attribute for numeric values
         */
}

Component References

Reference	Resolves To
components["schemas"]["NotificationChannelPreferences"]	NotificationChannelPreferences

OpenAPI Schema

{
  "title": "NotificationPreferences",
  "description": "Set channel preferences for each type of ",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/NotificationPreferences",
    "description": "API reference for the NotificationPreferences schema"
  },
  "required": [
    "transactional",
    "promotional",
    "newsletter"
  ],
  "properties": {
    "transactional": {
      "description": "These notifications are typically critical for user engagement, providing updates, confirmations, or alerts related to their account activities.",
      "$ref": "#/components/schemas/NotificationChannelPreferences"
    },
    "promotional": {
      "description": "These notifications aim to engage users with promotional content and enhance their overall experience with the platform.",
      "$ref": "#/components/schemas/NotificationChannelPreferences"
    },
    "newsletter": {
      "description": "These notifications are often sent periodically as part of a subscription service.\n",
      "$ref": "#/components/schemas/NotificationChannelPreferences"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions