Sign in

v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
iOS Wallet Templates API

Create the Apple Wallet template

Create the Apple Wallet (iOS) pass template for a wallet campaign. Field semantics follow Apple Wallet Passes (https://developer.apple.com/documentation/WalletPasses). Many text fields accept Liquid personalization tags that are replaced per recipient.

post/companies/{company_key}/campaigns/wallet/{token}/passbook_template

Path parameters

company_keystring required
tokenstring required

The token is the SmartLink token (wallet_id) for the campaign.<br><div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> If you are entering a real wallet token, please note that using the <b>"Try It"</b> feature on the righthand console will send an actual API call to our system. This may result in a wallet template being created.</div></div>

Headers

X-API-Versionstring
Content-Typestring required

Request body

Example request

{
  "passbook_template": {
    "organization_name": "Example Co",
    "pass_description": "Spring Sale offer",
    "logo_text": "Spring Sale",
    "colors": {
      "background": "#ff0000",
      "foreground": "#ffffff",
      "label": "#cccccc"
    },
    "barcode": {
      "type": "PKBarcodeFormatQR",
      "code": "{{ token }}",
      "description": "Scan at checkout"
    },
    "images": {
      "logo": {
        "url": "https://cdn.example.com/logo.png"
      },
      "icon": {
        "url": "https://cdn.example.com/icon.png"
      }
    },
    "fields": {
      "primary": [
        {
          "label": "Discount",
          "value": "20% off"
        }
      ]
    }
  }
}

Response

The Apple Wallet template was created.

idstring

Unique identifier of the Apple Wallet template.

activeboolean

Whether the template is active.

created_atstring

When the template was created, in ISO-8601 format.

updated_atstring

When the template was last updated, in ISO-8601 format.

organization_namestring

Organization name shown next to the lock-screen notification. Falls back to the signing certificate's value if not set.

pass_descriptionstring

Short accessibility (VoiceOver) description of the pass. Required by Apple Wallet; defaults to the card type if left blank.

logo_textstring

Text rendered beside the logo at the top of the pass.

nfc_messagestring

Payload delivered when the pass is tapped on an NFC terminal (tap-to-interact).

app_idstring

Optional iOS App Store identifier (for example id123456 or 123456). When set, the pass links to the associated app and surfaces an open-app affordance.

thank_you_urlstring

Optional URL opened after the pass is installed.

thank_you_messagestring

Optional message shown after the pass is installed. Ignored when thank_you_url is set.

sharing_prohibitedboolean

When true, hides the pass's share button.