Add app badge count

AWS will end support for Amazon Pinpoint on October 30, 2026,, and is no longer accepting any new users as of May 20 (see the linked doc). The guidance is to use AWS End User Messaging for push notifications and SMS, Amazon Simple Email Service for sending emails, Amazon Connect for campaigns, journeys, endpoints, and engagement analytics. Pinpoint recommends Amazon Kinesis for event collection and mobile analytics.

The app badge count, when set, can be seen on your app's icon on a user's device. Amplify provides you with simple helpers to manipulate this number.

App badge count helpers are safe to call (but will be ignored) even when your app is running on platforms where badges are not supported.

Get the current badge count

Use getBadgeCount to get the current app badge count. You might need to do this to calculate the value when setting the badge count.

final count = await Amplify.Notifications.Push.getBadgeCount();

Use setBadgeCount to set the current app badge count. Setting the badge count to 0 (zero) will remove the badge from your app's icon.

Amplify.Notifications.Push.setBadgeCount(42);