Subscription lists

Maintain individual audience lists of opted-in users.

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. This document explains Subscription audience lists.

About Subscription lists

A Subscription list is an audience list of opted-in devices, browsers, email addresses, and/or phone numbers. 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.

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.

After you create a Subscription list, you can:

To create a list, first you add a name and ID for the list in the dashboard, then you populate the list using the API.


Airship does not preserve the opt-in/out dates or the source of when or where a user opts into or out of a subscription list. Airship does not have access to dates for opt-/out events unless Real-Time Data Streaming (RTDS)A service that delivers engagement events in real time via the Data Streaming API or an Airship partner integration. is set up. See: RTDS API: Subscription List Event.

Creating your list

You can create up to 20 Subscription lists per project.

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

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

  3. 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.
  4. (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.

  5. Click Save.

Populating your list

Use the /api/channels/subscription_lists endpoint to add or remove users to your Subscription list.

Using Subscription lists

Managing Subscription lists

Go to Audience » Lists » Subscription. Each row displays:

  • List name
  • ID
  • Created and Last Modified dates

You can edit a Subscription list’s name and description, or delete the list. Click   to delete, or click  , make your changes, and click Save.