Preference Centers

Overview

Preference Centers contain one or more page sections, each with an optional title and description. Add the text and sections you want in the page and select at least one Subscription ListAn audience list of users who are opted in to messaging about a specific topic. Users can manage their opt-in status per list using a Preference Center. per section. You can also customize Subscription List names and descriptions to override those from your project settings.

You can change a Preference Center in the Airship dashboard at any time. Your saved edits are published in real time.

Email Preference Centers are Airship-hosted web pages. After creating the Preference Center in the dashboard, design a web page using our WYSIWYG editor and select a Preference Center to appear on the page. You can customize loading and saving status text and button labels and provide an Unsubscribe landing page URL. No development work is required.

Then, include the web page link in emails you send to a Subscription List. You can also test the page’s appearance in your web browser before making it available to your users.

App and Web Preference Centers can be displayed as individual pages in your app or website or embedded in a page. After creating the Preference Center in the dashboard, give your developer the Preference Center ID so they can add it to your website or app.

You can direct users to an App or Web Preference Center in multiple ways:

• App and website navigation
• Link or deep link
• The Preference Center ActionA configurable behavior that occurs when a user interacts with your message, e.g., opening a web page. in a push notifications or in-app message
• The Preference Center WYSIWYG button action in a Rich PageA landing page or Message Center message in your app that can include HTML, video, etc. or In-App AutomationMessages that are cached on users’ devices and displayed when your users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times.

Single- or multi-channel

Preference centers can support either a single channel or multiple channels. Multi-channel Preference Centers can be configured for a single channel.

Channel support, opt-in/out handling, and Airship plan requirements for each Preference Center type:

In both Preference Center types, you can manually group Subscription Lists under headings you create. For multi-channel only, you also have the option to organize Subscription Lists automatically by channel:

Subscription List opt-in/out handling per channel

Subscription List opt-in status change handling for Preference Centers:

Notification opt-in prompts and contact information

In an App Preference Center, you can add notification opt-in prompts for App, Web, Email, and SMS. They appear as embedded banners. For Email and SMS, users must add at least one email address or phone number, and users can manage addresses and numbers already opted in. All labels and fields within the prompts and modals are fully customizable.

For App and Web, the prompt banner appears in the Preference Center on devices that have notifications disabled. You configure a single prompt for both App and Web that contains a button for opting in. Selecting the button opens the native notification settings for your app or a browser message asking the user to allow web notifications. For a web Preference Center, your web developer must code an action for the button.

For Email and/or SMS, the prompt banner appears whether or not a user has added an email address or phone number. Opted-in addresses and phone numbers associated with a Named UserA customer-provided identifier used for mapping multiple devices and channels to a specific individual. are listed within the prompt banner. Users can add email addresses or phone numbers in order to opt in, add other addresses or numbers, or remove their contact information in order to opt out. Addresses or numbers added by the user are automatically associated with their Named User ID, allowing for cross-channel messaging.

Users must complete the Double Opt-InA process where users who sign up for messaging must confirm opting in before they can receive messages. process in order to start receiving messages. Learn more about how double opt-in works for Email and SMS. Your double opt-in workflow must be in place before saving an Email or SMS opt-in prompt in a Preference Center.

When removing an email address, users are opted out of Commercial EmailPromotional messaging sent to an audience of users who have opted in to receive marketing messages from you. only.

Required for Email and SMS opt-in prompts: iOS SDK 18.6+Android SDK 18.1.2+

Reporting

Changes to subscription status are recorded as Real-Time Data StreamingA service that delivers engagement events in real time via the Data Streaming API or an Airship partner integration. events. For single-channel Preference Centers, the events are per channel. For multi-channel, they include the Named UserA customer-provided identifier used for mapping multiple devices and channels to a specific individual.. See Subscription Event and Subscription List Event in the Real-Time Data Streaming API reference.

Even if you do not use Airship for all your channels, you can still use multi-channel Preference Centers for your other channels and keep your external providers in sync via Named User subscription status.

Setup

First, create the Preference Center in the dashboard, and then see the Implementation sections for App and Web or Email.

Creating a Preference Center

The Company account Owner or a team member with Administrator permission can create and manage Preference Centers. You can create a maximum of 50 Preference Centers per project.

1. Go to Settings.
2. Under Project Configuration, select Manage for Preference Centers.
3. Select Create Preference Center.
4. Define the Preference Center:

   Field	Description
   Name and Description	These appear in the Airship dashboard only. The Preference Center ID is automatically generated based on the name. An ID will not generate for a name that contains only numbers and/or special characters. If the name starts with a number and/or special characters, the generated ID omits the leading numbers and/or special characters. Uppercase letters in the name are converted to lowercase in the ID. Special characters in the name are converted to underscores in the ID and only appear if followed by numbers or letters.
   Type	For single-channel Preference Centers only. Options: Mobile App, Web, Email.
   ID	You can enter your own ID instead of using the auto-generated one, using letters, numbers, and underscores. The ID must start with a letter and end with a letter or number. You cannot change the ID later.

5. Select Save and continue.
6. (Multi-channel only) Select a layout. You can group Subscription Lists automatically by channel or manually under headings you create. If grouping by channel, select a channel to set up first. If a multi-channel Preference Center is organized by channel, Email automatically appears first.

Now you can design the appearance of the Preference Center.

1. Set the title and description. For multi-channel Preference Centers, they apply to all selected channels.

   The Title is intended to appear as a page heading, with the Description appearing below. Their values apply to all channels, but appearance and control options vary:

   • For apps, they appear in the navigation bar at the top of your Preference Center. If you do not enter a title, the default title “Notifications” appears.
   • For web, your developer can control how they appear (or do not appear) in the Preference Center on your website.
   • For email, the title is a level-one HTML heading (<h1>), and the description is an HTML paragraph (<p>). They inherit whatever styles apply more generally from the surrounding page.

2. (Optional for App Preference Centers) Add notification opt-in prompts and contact information. Follow the steps in the next section.

Next, configure page sections. Select Add another section for more page sections.

Fields in each section:

For multi-channel Preference Centers grouped by channel:

• To add channels, select Add, and select a channel. To remove a channel, select its tab, and then select Remove channel. Make sure to configure the page sections for each channel.
• To customize channel names, select Settings , then Channel names, enter the names as you want them to appear in the Preference Center, then select Save. If you want to change the name and description of a Subscription List, you must edit the list itself. See Managing Subscription Lists.

When you have completed configuration, select Save and publish.

Configuring opt-in prompts and contact information

When creating an App Preference Center, you can add a section that prompts the user to opt-in to messaging and where they can manage their email addresses and phone numbers.

1. Under Opt-in prompts, select Add next to App/Web, Email, or SMS.

2. (For App/Web) Configure fields for the title, body, button label, and button accessibility description. The accessibility description is optional text to be announced by assistive technology, such as screen readers. This overrides the announcement of the button label text. Selecting the button opens the native notification settings for your app or a browser message asking the user to allow web notifications.

3. (Optional for App/Web) Add an icon image. No icon is present by default. Enter an HTTPS URL for an icon image. The icon image may not render in preview. Open your app to review its appearance. See also Personalizing media URLs.

   If your Airship plan includes CDN support, you can also upload media or select from previously uploaded media.

   1. Select Upload and then Insert Media.
   2. Select Choose file and select a file to upload or select from previous uploads.
      • The default sort order is most recent upload first.
      • You can search by file name or keyword.
      • A file preview appears after upload or selection. Select the play icon () to preview audio and video files.
   3. (Optional) Add or edit keywords for the file to help organize your uploads.
      • Enter a term in the search field below the preview and select from results, or select Add keyword: [term].
      • Select the clear icon () to remove a keyword.
   4. Select Insert selected media.

   

   See also Media library. Contact Support  if you are interested in enabling CDN media hosting.

4. (For Email and SMS)iOS SDK 18.6+Android SDK 18.1.2+ Configure fields for each step:

   Step	Format	Purpose and actions	Fields
   Prompt	Embedded banner	The body should inform the users about the communications they are opting/opted into. Before entering an email address or phone number, customizable text appears next to an "i" icon (). Afterward, the text is replaced with obfuscated contact information and and a link for resending the verification email or text message also appears. Selecting the button opens the contact information form.	Title Body Info (If no contact information is present) Button label: Add email address or phone number Link label: Resend verification email or text message
   Contact information form	Modal	This appears to the user after selecting a button for adding an email address or phone number. The body should inform the user that they will receive a verification email or text message they must respond to in order to complete opting in. For SMS country code, you must select at least one Sender IDAn originating phone number or string identifier used to indicate who an SMS message comes from. Members of your audience subscribe (opt in) to each sender ID they want to receive messages from. to populate the country code menu that will appear in the Preference Center. You can select a single sender ID per country. The Footer can be used for details and disclaimers, and you can add links using Markdown in the format [Terms & Conditions](https:/www.example.com/terms).	Title Body Email field (Email only) Email placeholder (Email only) Country code heading (SMS only) Country code menu (SMS only) Phone number field (SMS only) Button label: Cancel Button label: Submit Footer
   Confirmation: Contact information submitted	Modal	This appears after the user submits the contact information form. The body should inform the user they successfully submitted their contact information and to check for the verification email or text message. Selecting the button closes the modal.	Title Body Button label: Close
   Confirmation: Verification message resent	Modal	This appears when the user selects the link for resending the verification email or text message. The body should inform the user that the verification message resent. Selecting the button closes the modal.	Title Body Button label: Close
   Confirmation: Opt-out	Modal	This appears when a user selects the trash can icon () to remove an email address or phone number. The body should inform the user they will be opted out of messaging for that address or number. For email, users are opted out of Commercial EmailPromotional messaging sent to an audience of users who have opted in to receive marketing messages from you. only. Selecting either button closes the modal.	Title Body Button label: Cancel Button label: Submit

5. Select Save.

6. Complete the remaining steps for creating the Preference Center.

Implementation: App and Web

Your app or web developer must place your Preference Center widget in the desired area of your app or website. If you included a notification opt-in prompt for Web, your web developer must also code an action for the button.

1. Go to Content, then Web Pages.
2. Copy the ID for a Preference Center.
3. Give the ID and the following platform docs links to your developer:
   • Mobile
   • Web

Implementation: Email

Next, create the Airship-hosted web page where you will embed your Preference Center:

1. Go to Content, then Web Pages.
2. Select Create web page.
3. Enter a name and description for your Preference Center web page, and select Continue. These fields are for use within the Airship dashboard only and do not appear in your form. Description is optional.
4. Select Add for HTML and select a default or saved layout, or select Blank Layout to design your own. You can edit any layout after selecting. Then design the page. See WYSIWYG editor for details.
   • Your layout must include at least one Preference Center element.
   • Personalization is not supported.
   • A placeholder is shown within the WYSIWYG editor, not your Preference Center design.
   • Select Preview to see how the web page will appear on desktop and mobile devices.
5. Select Done when you are finished designing the page.
6. Select Save web page to return to the list of all web pages in your project.

Testing an Email Preference Center web page

After Creating an Email Preference Center web page, you can see how it will appear to your users by sending its link in an email to a Test GroupA preview group is audience group used for previewing personalized content in the dashboard. Wherever a personalization preview is available, you can select a preview group, and its group members’ attributes will appear for any Handlebars references to attributes. You can enable any preview group as a test group so you can send test messages to its group members. These messages appear as tests in Messages Overview. or by manually editing the web page URL.

To send a test email:

1. If you do not already have a Test Group, create or edit one now, adding yourself as a member using your email address. See Preview and test groups.
2. Go to Content, then Web Pages.
3. Select the link icon () for a Preference Center web page to copy its URL.
4. Select the plus icon () in the navigation header and select the Message composer.
   • In the Audience step, enable the Email channel, then select Test Users, enter your test group name, and select from the results.
   • In the Content step, include the Preference Center link in the body of the email.
   • In the Delivery step, select Send Now.
5. After sending, check your email for your test message, and follow the Preference Center link.

To test the web page without sending a message, add a Channel IDAn Airship-specific unique identifier used to address a channel instance, e.g., a smartphone, web browser, email address. to the Preference Center’s URL:

1. Go to Content, then Web Pages.
2. Select the link icon () for a Preference Center web page to copy its URL.
3. Paste the URL in your browser’s address bar, replace {{$channel.id}} with an actual channel ID, and hit Enter on your keyboard.

You should now see your rendered Email Preference Center web page.

Directing users to a Preference Center

In addition to adding a Preference Center to your app or website or providing a link or deep link, you use can Airship’s built-in actions to open a Preference Center when a user interacts with a message or taps a button:

• For push notifications and in-app messages, select the Preference Center ActionA configurable behavior that occurs when a user interacts with your message, e.g., opening a web page. in the Content step in a Message, Automation, A/B Test, or Sequence.
• For Rich PagesA landing page or Message Center message in your app that can include HTML, video, etc. and In-App AutomationMessages that are cached on users’ devices and displayed when your users meet certain conditions within your app, such as viewing a particular screen or opening the app a certain number of times., select the Preference Center button action when configuring content using the WYSIWYG editor. See Actions in the WYSIWYG editor.

For Email Preference Centers, add the URL as a link in an email message or TemplateReusable message content. Templates support personalization using merge fields and other logic.. To get the web page URL:

1. Go to Content, then Web Pages.
2. Select the link icon () for a Preference Center web page, and it will save to your clipboard.

You must send your email using Airship. The Preference Center will not load for a user if sent from a system other than Airship.

Only link to an email Preference Center from an email.

Managing Preference Centers and web pages

The Company account Owner or a team member with Administrator permission can create and manage Preference Centers.

Go to Settings, then select Manage for Preference Centers. The most recently modified Preference Center appears first. Select a column header to sort by name, ID, date created, or date modified. Select the Archived filter to see all archived Preference Centers.

• Archive Preference Center — Archiving a Preference Center removes it from the Airship dashboard only; it does not affect its usage in your app or website. Archived Preference Centers count toward the maximum of 50.

To manage Email Preference Center web pages, go to Content, then Web Pages. The most recently modified web page appears first. Select a column header to sort by name, date created, or date modified. You can also search by name.

Options:

Migrating to a user-level Preference Center

Single-channel Preference Centers created before October 10, 2022, update at the channel level. After migrating to a user-level Preference Center, preferences are updated at the Named UserA customer-provided identifier used for mapping multiple devices and channels to a specific individual. level per channel type. For instance, if a user has two app channels and they update a preference for an app Subscription List, then Airship updates both app channels for their named user, not just the one for the device they are on.

User-level App Preference Centers require: iOS SDK 16.9+Android SDK 16.7+

Do not migrate until your SDK has been updated.

• Android migration guides 
• iOS migration guides 

1. Go to Settings.
2. Under Project Configuration, select Manage for Preference Centers.
3. Select the pencil icon () for a Preference Center.
4. Select Start migration process. This option only appears if the Preference Center is currently channel-level.
5. Check the terms box and select Migrate Preference Center. Migration takes seconds to complete.
6. Select Save and publish to apply the changes.