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)

KeyTypeDescriptionDefaultRange

Notification settings

required
arrayAn array of notification settings dictionaries.Default: —Range: —

Notification setting

dictNotification settings for an appDefault: —Range: —

Enable notifications

booleanIf 'true', enables notifications for this app.Default: trueRange: —

App bundle identifier

required
stringThe bundle identifier of the app to which to apply these notification settings.Default: —Range: —

Show in Notification Center

booleanIf 'true', enables notifications in the Notification Center for this app.Default: trueRange: —

Show in Lock Screen

booleanIf 'true', enables notifications on the Lock Screen for this app.Default: trueRange: —

Show in CarPlay

iOS 12.0+ · not on macOS

booleanIf 'true', enables notifications in CarPlay for this app.Default: trueRange: —

Sounds enabled

booleanIf 'true', enables sounds for this app.Default: trueRange: —

Badges enabled

booleanIf 'true', enables badges for this app.Default: trueRange: —
AlertTypeinteger

Alert type

integerThe type of alert for notifications for this app: '0': None '1': Temporary Banner '2': Persistent BannerDefault: 1Range: None (0), Banners (1), Alerts (2)

Preview type

iOS 14.0+ · not on macOS

integerThe 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 previewsDefault: —Range: Always (0), When Unlocked (1), Never (2)

Grouping type

iOS 12.0+ · not on macOS

integerThe 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: 0Range: Automatic - Group notifications app-specific groups (0), By App - Group notifications into one group (1), Off - Do not group notifications (2)

Critical alert enabled

iOS 12.0+

booleanIf 'true', enables critical alerts that can ignore Do Not Disturb and ringer settings for this app.Default: falseRange: —