Manage Tag Groups

A tag group is an array of tags that you can associate with both channels and named users. They are used for organizing tags.

You can create up to 100 custom tag groups in addition to the predefined Primary Device Tags group. See Targeting Your Audience and the API tutorial Create and push to a tag group to learn more about using tag groups.

Create a Tag Group

 Warning

You cannot delete tag groups, nor can you edit the Group Key field or Allow these tags to be set only from your server security setting. Check that your Group Key and security setting are correct before saving your tag group.

 Note

Airship reserves tag groups prefixed with "ua_". Any tag groups you might create with that prefix will not function.

  1. Open your messaging project and go to Settings » APIs & Integrations » Tag Groups.
  2. Click Create Tag Group and configure the fields.
    • Name: This name appears elsewhere in the dashboard, so choose something easily understandable and that describes the associated database, e.g., "Loyalty Database Tags."
    • Description: The description should supplement the name, giving additional information about the tag group, if necessary. Be descriptive enough that anyone in your company would understand its source and purpose.
    • Group Key: This permanent, unique ID is the text you will use when referring to your tag group in the API. While you can use any characters for the group key, it is highly recommended that you exclusively use lowercase ASCII characters. No spaces are allowed in a group key. Example: pos-database.
  3. (Optional) Enable Allow these tags to be set only from your server. This increases security for read-write operations, only allowing tags be read or changed by API calls authenticated with your master secret key.
     Note

    Without this security setting enabled, tags can be read and written from an app using only the application secret. Enabling this setting requires read-write operations to be validated with your master secret key, preventing attackers from using the app secret to set or read their own device tags. Whether or not your app will benefit from this added security depends on the use case. If preventing attackers from reading or setting their own device tags is absolutely critical, consider enabling this feature.

  4. Click Save.

Enable or Disable a Tag Group

  1. Open your messaging project and go to Settings » APIs & Integrations » Tag Groups. Disabled tag groups are greyed-out.
  2. Click the pane of a custom tag group and check or uncheck the box for Enable this Tag Group.
  3. Click Save.

Edit a Tag Group

  1. Open your messaging project and go to Settings » APIs & Integrations » Tag Groups. Disabled tag groups are greyed-out.
  2. Click the pane of a custom tag group and make your changes. Only Name and Description are editable fields.
  3. Click Save.