PayloadKit

Notifications

com.apple.notificationsettings

The payload that configures notifications.

iOS 9.3+macOS 10.15+
Apple schemaexclusive

Requires supervision on iOS · Not available with User Enrollment

Configuration Keys (1)

KeyTypeTitle
NotificationSettingsrequired

An array of notification settings dictionaries.

arrayNotification settings
NotificationSettingsItem

Notification settings for an app

dictNotification setting
NotificationsEnabled

If 'true', enables notifications for this app.

Default: true

booleanEnable notifications
BundleIdentifierrequired

The bundle identifier of the app to which to apply these notification settings.

stringApp bundle identifier
ShowInNotificationCenter

If 'true', enables notifications in the Notification Center for this app.

Default: true

booleanShow in Notification Center
ShowInLockScreen

If 'true', enables notifications on the Lock Screen for this app.

Default: true

booleanShow in Lock Screen
ShowInCarPlay

iOS 12.0+ · not on macOS

If 'true', enables notifications in CarPlay for this app.

Default: true

booleanShow in CarPlay
SoundsEnabled

If 'true', enables sounds for this app.

Default: true

booleanSounds enabled
BadgesEnabled

If 'true', enables badges for this app.

Default: true

booleanBadges enabled
AlertType

The type of alert for notifications for this app: '0': None '1': Temporary Banner '2': Persistent Banner

Default: 1

Range: None (0), Banners (1), Alerts (2)

integerAlert type
PreviewType

iOS 14.0+ · not on macOS

The type previews for notifications. This key overrides the value at Settings>Notifications>Show Previews. '0' - Always: The device shows previews when locked and unlocked '1' - When Unlocked: The device shows previews only when unlocked '2' - Never: The device never shows previews

Range: Always (0), When Unlocked (1), Never (2)

integerPreview type
GroupingType

iOS 12.0+ · not on macOS

The type of grouping for notifications for this app: '0': Automatic: Group notifications into app-specified groups. '1': By app: Group notifications into one group. '2': Off: Don't group notifications.

Default: 0

Range: Automatic - Group notifications app-specific groups (0), By App - Group notifications into one group (1), Off - Do not group notifications (2)

integerGrouping type
CriticalAlertEnabled

iOS 12.0+

If 'true', enables critical alerts that can ignore Do Not Disturb and ringer settings for this app.

Default: false

booleanCritical alert enabled