Adaptive Links Tutorial

Adaptive Links bridge the gap between email, SMS, and digital wallet passes via an intelligent linking system capable of building and distributing platform-appropriate digital wallet passes on demand.

See the Adaptive Links guide for more information. See also: Reach Templates Menu Guide: Adaptive Links.

Tip

You can even use an Adaptive Link for a single platform. If a user on the unsupported platform attempts to install your pass, you can set the link to drive the user to a landing page of your choosing.

When creating the Adaptive Link, use ID null for the second template, and make sure to include a value for landingPageUrl.

This applies to Adaptive Links created via the API only.

Note

Adaptive Links may also be created via the API. See: Adaptive Links API Tutorial.

What You'll Do

In this tutorial, you will:

  1. Configure your Adaptive Links in the dashboard.

Features and options are explained along the way.

Steps

Important

You must already have at least one Apple Wallet and one Google Pay template to associate with each other. If not, create and design a template in the dashboard now:

Create an Adaptive Link by associating an Apple Wallet template with a Google Pay template.

Note

You cannot create boarding pass adaptive links using this tutorial. You must create flights and/or boarding pass adaptive links through the API. See Boarding Pass Adaptive Links for information about creating boarding pass adaptive links.

  1. Open your project from the dashboard, then click Templates.
  2. Click anywhere in a template's row to see its expanded view, then click the Select an Apple Wallet/Google Pay template button. If you have only one template in the project, the initial view is expanded.The screen will open to Generate New Adaptive Link.
  3. Optionally enter a descriptive name for the link. This name appears in the list of all the template's Adaptive Links. It does not appear to recipients of the link.
  4. Type the template name or ID, and results will display below the entry field. Click to select.
    If you want to change your selection, click the pencil icon and start over.
  5. Choose what will happen if the pass is opened in a desktop browser or undetectable device type rather than a mobile device. Select a radio button.
    • Display error on the device: The device will display: {“error”:{“code”:1004,“message”:“Device not supported.“}}.

    • Redirect to a landing page: Enter the URL that the pass should redirect to.
      Important

      If you intend to send the link to web browsers via the Adaptive Link action in the dashboard, select Redirect to a landing page to ensure that your web users do not get an error.

  6. Optionally enable Personalization and/or restrict the number of Available Passes.
    • Personalized: If enabled, an individual pass URL is generated each time the Adaptive Link is clicked, ie., 10 clicks = 10 unique passes created, and 10 installs counted.

      If disabled, the same pass URL is generated each time the Adaptive Link is clicked, i.e., 10 clicks = 1 unique pass created, and 10 installs counted.
      Note

      If you designed the pass templates to use personalized data such as first name, points, and/or a barcode value, enable Personalization.

      Note

      When Personalization is disabled, you cannot update an adaptive link to update passes generated from the adaptive link. Rather, you must publish template updates through the dashboard or using the Bulk Update API to push updates to passes generated from the adaptive link.

    • Available Passes: Enter the number of passes that can be created from this Adaptive Link. If left blank, the number of passes is not limited.
  7. Click the Save button, or Cancel to discard.

Modification

Adaptive Links created via the dashboard can be edited or deleted via the dashboard or API. Adaptive Links created via the API can be edited or deleted via the API but only deleted in the dashboard.

Dashboard

  1. Open your project from the dashboard, then click Templates.
  2. Click anywhere in a template's row to see its expanded view, then click the pencil icon in the header of the Adaptive Link you would like to edit.
  3. Make your desired changes, then click the Save button, or Cancel to discard.

API

To modify or delete Adaptive Links via the API, see: Wallet API: Adaptive Links.

Send the Pass

Now that you have an Adaptive Link, you can distribute its related pass in multiple ways. See: Pass Distribution Methods.

Tutorials