Application Load

IProfileNotificationSettingsRequest

The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.

IProfileNotificationSettingsRequest

Settings for individual email notification types or all optional notifications.

app/interfaces/orionplace/accounts/IEmailVerification.ts
TypeScript
export interface IProfileNotificationSettingsRequest {
  // Array of notification type keys and their `enabled` values. Use the keys
  // returned in the current settings. When supplied, this array takes
  // precedence over `enabled`.
  settings?: Array<
    Pick<IProfileNotificationSetting, 'template_type' | 'enabled'>
  >;
  // `true` enables optional account email notifications; `false` disables them.
  // A saved email is required to enable notifications.
  enabled?: boolean;
}