Adaptive Links Tutorial

An adaptive link is a single URL that detects the platform for users who click or tap the link and installs the correct pass for either Apple Wallet or Google Pay. You can send adaptive links to your audience to support them without knowing their platform.

This page helps you create and modify adaptive links through the dashboard. For help creating and modifying adaptive links using the API, see: Wallet API: Adaptive Links.

 Tip

When creating adaptive links through the API, you can 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.

You must have at least one Apple Wallet and one Google Pay template to create an adaptive link. If not, create and design your templates first.

 Note

You cannot create boarding pass or event ticket 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 wallet project from the dashboard, then click Templates.
  2. Click anywhere in a template's row to see its expanded view, then click Select an Apple Wallet/Google Pay template. If you have only one template in the project, the initial view is expanded.
  3. (Optional) 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 select from the results.If you want to change your selection, click 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. (Optional) 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 Save.

You can create and modify adaptive links for pass types other than boarding passes or event tickets through the dashboard or API. But, if you create an adaptive link through the API, you cannot modify it in the dashboard. You must create boarding pass and event ticket adaptive links through the API.

To modify adaptive links in the dashboard:

  1. Open your project from the dashboard and click Templates.
  2. Click anywhere in a template's row to see its expanded view, then click in the header of the adaptive link you want to edit.
  3. Make your changes and click Save.

By default, adaptive links expire after 6 months if they are unused. After you or a member of your audience uses an adaptive link to generate a pass, the link persists forever.

If you generate passes for an entire audience from a single adaptive link, then generating a test pass will cause the link to persist forever. If you distribute personalized adaptive links to your whole audience, then it's likely that some adaptive links will expire after six months, as not all users will click or tap their personalized link.

Passes generated from an adaptive link expire based on pass type or values set at the template or pass level.

Send the Pass

Now that you have an adaptive link, you can distribute its related pass in multiple ways.