Ban Lists

A Ban List has these components:

• Your record of banned users — These may be users compiled from “Do not contact me” responses or any other reason to omit them from messaging. You decide the record’s format and storage location outside of Airship. Each user must be associated with a Named UserA customer-provided identifier used for mapping multiple devices and channels to a specific individual. or Channel IDAn Airship-specific unique identifier used to address a channel instance, e.g., a smartphone, web browser, email address.. We recommend Named User since it maps to all Channel IDs associated with a user.
• A connection to your record — This is in the form of a webhook  that Airship will use to query your data.
• A Ban List configuration in your Airship project — You will enter a request URL for the webhook and confirm Airship is authorized to use it for its intended purpose.

Once the above items are in place:

1. Airship makes an API call to your webhook for every Channel ID in a message audience.
2. Your webhook checks your record of banned users for matches for each Channel ID. If a match is found, the webhook sends a response telling Airship to drop the matched user.
3. Airship drops the send for each match.

Each dropped recipient counts toward the Not Sent count in a message report, and a SEND_ABORTED event occurs when a recipient is dropped from our system before delivery is attempted.

Additionally, you can set a frequency rate for your requests and also have the option to bypass your Ban List when sending business-critical or otherwise required messages, such as privacy policy update notifications.

You can set up one Ban List per project. Ban Lists are not supported for In-App AutomationMessages cached on users’ devices and displayed when users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times., ScenesA single or multi-screen in-app experience cached on users’ devices and displayed when users meet certain conditions in your app or website, such as viewing a particular screen or when a Custom Event occurs. They can be presented in fullscreen, modal, or embedded format using the default swipe/click mode or as a Story. Scenes can also contain survey questions., or SurveysA question-and-answer experience used to collect and aggregate feedback or generate a net promoter score. The Survey composer was deprecated September 9, 2024. All Survey composer functionality is available in Scenes.. Ban List support for in-app experiences was released June 17, 2024.

Documentation

Get all the details in Ban Lists.