Managing wallet passes

IMPORTANT: This feature is available in private preview mode and accessible only on selected workspaces. To get access, contact your account manager or Synerise Support.

Editing a wallet pass

You can edit an existing a wallet pass. While you're doing this, the system keeps serving the last published version of the pass.

  1. Go to Experience Hub icon Experience Hub > Wallet passes.
  2. Click the wallet pass you want to edit.
  3. In the upper-right corner, click Save as draft.
    Result: This creates a new draft version of the wallet pass, where you can make your edits.
    If the button says Save draft instead of Save as draft, that means a draft already exists and you're editing it.
  4. Edit the wallet pass in the same way as when creating one.
  5. When you finish:
    • To save the draft for later work or publishing, click Save as draft.
    • To publish the new version to customers:
      1. Click Publish now.
      2. Push the update to customers.

Restoring a wallet pass version

To restore and republish a wallet pass version:

  1. Go to Experience Hub icon Experience Hub > Wallet passes.
  2. Click the wallet pass you want to edit.
  3. In the upper-right corner, click Version history.
  4. In the panel that opens, click the version you want to restore.
    Result: The version opens in the editor. You can review it.
  5. Click Save as draft.
    Result: The system creates a new draft version of the pass from the version you selected.
  6. Edit the wallet pass in the same way as when creating one.
  7. When you finish:
    • To save the draft for later work or publishing, click Save as draft.
    • To publish the new version to customers:
      1. Click Publish now.
      2. Push the update to customers.

Updating a wallet pass on customer devices

Synerise doesn't monitor a dynamic field's underlying data on its own, so nothing updates the pass until you trigger an update. Do so whenever that underlying data is likely to have changed for a cardholder:

  • A dynamic field's value changed - for example, a pass field uses an expression to calculate a cardholder's points balance. When the cardholder installs the pass, the expression may resolve to 0 points. The cardholder then completes a transaction unrelated to the pass itself; afterward, the same expression resolves to 100 points. Until you trigger an update, the pass on the cardholder's device still shows 0 - the device has no way of knowing the underlying value changed.
  • You manually edited a static field's value in the wallet pass template. That new value only reaches the pass once you trigger an update.

Update methods

You can push an update to a pass that's already installed on a customer's device in the ways listed below. Neither method lets you set field values directly. Instead, triggering an update re-evaluates the pass's dynamic field values - see Defining dynamic fields.

Calling the update endpoint directly

You can use the POST /wallets/update endpoint.

Using the Update Wallet Pass node

No API key is needed - the node runs as part of the workflow. For the node's configuration, see Update Wallet Pass node.

  • Add the Update Wallet Pass node to a profile-oriented workflow in Synerise, so the update is triggered automatically as part of an automation - for example, as a step right after the event that recalculates the cardholder's balance.

Consequences for end users

The customer receives a notification only if a value actually changed as a result of the update; if nothing changed, the update still succeeds but no notification is sent. This notification is generated natively by the Wallet app on the device, not by your own mobile app - the field's update notification text (see Defining dynamic fields) is the only part of its content you control.

NOTE: Update notifications are only delivered on Apple Wallet (iOS). Google Wallet doesn't notify the customer when a pass is updated.

Each update also generates a walletPass.updated event, which you can use for further automation or analytics.

Auditing wallet pass changes

Wallet pass changes are tracked in the audit log under the brickworks consumer. This is because wallet passes are saved as records of a special-purpose Brickworks schema called "Wallet Card Design". DO NOT edit this schema.
When someone creates, edits, or deletes a wallet pass, that action is saved to the audit log as an action made towards a Brickworks record. The changes made to the fields in the wallet pass are in the values object of the log entry.

Canonical URL: https://hub.synerise.com/docs/campaign/wallet-passes/managing-wallet-passes