Subscription lists

Audience lists are messaging recipient groups based on either your own data or automatically-generated app user lifecycle information. You can use audience lists to target specific users.

About subscription lists

A Subscription list is an 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. Subscription lists can help with retaining customers, since recipients can opt in and out of content per list rather than opting out of all messaging.

After you create a subscription list, you can:

• Select the list when defining your audience for a message
• Opt a user in to or out of a subscription when the user taps a button in a push notification, in-app message, or web push notification
• Trigger an AutomationA set of conditions that your audience must meet before they receive a message. or SequenceA series of messages that is initiated by a trigger. Airship sends messages in the series based on your timing settings, and you can also set conditions that determine its continuation. Sequences can be connected to each other and to other messaging components to create continuous user experiences in a Journey. when a user opts in to or out of a subscription, or use their opt-in status as a ConditionTag-, channel-, or subscription-based requirements for members of your audience to receive a message from an automation or sequence. The message is not sent if your conditions are not met.
• Include the list in a SegmentA grouping of audience members selected by unique or shared identifiers. Multiple identifiers can be combined within a segment.
• Include the list in a Preference CenterA page where users can manage their opt-in statuses for the subscription lists in your project. Preference centers are presented within your app or website or as an Airship-hosted web page.
• Opt users in to or out of a subscription list when they respond with an SMS KeywordA word you define to perform an action when used in a mobile-originated message, such as triggering a text response, opting in a user, or applying a tag for segmentation.

---

A subscription list is for either commercial or transactional purposes, which you specify when creating the list.

• Commercial — Advertises or promotes a commercial product or service, including content on a website operated for a commercial purpose.

• Transactional — Facilitates an already agreed-upon transaction, or updates a customer about an ongoing transaction. Verify with your legal team to comply with regulations.

When you send to the list, you should only include content related to its purpose.

When sending an email to a subscription list, you must include an unsubscribe link for opting out of all messages, and you can also include an unsubscribe link for that list only. See: Unsubscribe links.

---

You create subscription lists in the dashboard, and you can add users using these methods:

• Automatically — Enable Auto opt-in when creating a transactional list.
• Manually — Use the API to add or remove users.
• User choice — Include the list in a Preference CenterA page where users can manage their opt-in statuses for the subscription lists in your project. Preference centers are presented within your app or website or as an Airship-hosted web page. .

Auto opt-in

AXP

When creating a transactional subscription list, you can automatically opt in users to that list by enabling Auto opt-in. Both existing and new audience members will be opted in to the list.

Auto opt-in cannot be disabled after saving your list. Lists enabled for auto opt-in are not available for use with the Subscription trigger for Sequences and Automation.

Creating a list

You can create up to 20 subscription lists per project.

1. Go to Audience » Lists » Subscription and click Create subscription list.

2. Enter a name and description for the list. Both appear in your project’s Preference CentersA page where users can manage their opt-in statuses for the subscription lists in your project. Preference centers are presented within your app or website or as an Airship-hosted web page. . Description is optional.

   • The list ID is automatically generated based on the name and is truncated at 32 characters.
   • A list ID will not generate for a list 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.

3. (Optional) Edit the list ID. Letters, numbers, and underscores only, and must start with a letter and end with a letter or number. 32 characters maximum. You cannot change the list ID later.

4. Click Next.

5. Enable the channels you want to include in the list.

6. Select a subscription type: Commercial or Transactional. Commercial is selected by default. You cannot change the subscription type after you save the list.

7. (Optional for Transactional lists) Check the Auto opt-in checkbox to enable auto opt-in. You cannot change this setting after you save the list.

8. Click Save.

Populating a list using the API

Subscription lists are set at the user level to support multi-channel preferences. Use the Named User Scoped Batch Operations endpoint to add or remove users to/from your subscription list.

Using subscription lists

• Message audience — Select a subscription list when defining your audience in the Message and A/B Test composers. See: Target Specific Users. To send to a subscription list using the API, use the subscription_list atomic selector.

• Buttons — AXP Opt a user in to or out of a subscription list when the user taps a button in your message. Minimum SDKs required: iOS 16.9.0 and Android 16.7.0. See:

  • Optional Features: Buttons (App)
  • Optional Features: Buttons (Web)

• Automation and sequence trigger and condition — Trigger an AutomationA set of conditions that your audience must meet before they receive a message. or SequenceA series of messages that is initiated by a trigger. Airship sends messages in the series based on your timing settings, and you can also set conditions that determine its continuation. Sequences can be connected to each other and to other messaging components to create continuous user experiences in a Journey. when a user opts in to or out of a subscription, or use their opt-in status as a ConditionTag-, channel-, or subscription-based requirements for members of your audience to receive a message from an automation or sequence. The message is not sent if your conditions are not met. . See:

  • Automation Triggers and Conditions
  • Sequence Triggers and Message Conditions

• Segments — Include a subscription list in a SegmentA grouping of audience members selected by unique or shared identifiers. Multiple identifiers can be combined within a segment. . See: Create reusable audience segments. This is essentially the same process used when defining your audience in a composer, but the audience information is saved for reuse for other messages. For the API, see the /api/segments endpoint.

• Preference centers — Add subscription lists to Preference CentersA page where users can manage their opt-in statuses for the subscription lists in your project. Preference centers are presented within your app or website or as an Airship-hosted web page. .

• SMS keywords — Set up keywords your audience can use to opt in to or out of your subscription lists. Once added to your project, you can include the keywords in your SMS messages.

Managing subscription lists

Go to Audience » Lists » Subscription. The default sort order is by last modified. Each row displays:

• List name and ID
• Type — Commercial or Transactional, and Auto opt-in, if enabled
• Channels
• Description
• Date and time last modified (browser local time)
• Audience count — The number of Channel IDsAn Airship-specific unique identifier used to address a channel instance, e.g., a smartphone, web browser, email address. in the list and the time it was last calculated (browser local time). Click   to generate an updated count.

Lists for all channels appear by default. Click All channels   and select a channel to filter for only lists enabled for that channel. You can search for lists by name, ID, or description.

Click   to edit a list’s name, description, or enabled channels. Click   to archive.