v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Wallet Location Selector API

Update the location selector

Update the branded "Add to Wallet" landing page for a wallet campaign.

put/companies/{company_key}/campaigns/wallet/{token}/location_selector

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> 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 location selector being updated.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

Example request

{
  "location_selector": {
    "header": {
      "title": "Add your pass",
      "tagline": "Tap below to save it to your wallet"
    },
    "colors": {
      "background": "#ffffff",
      "foreground": "#000000",
      "label": "#888888"
    },
    "include_zipcode": true,
    "add_to_wallet_language": "en-US"
  }
}

Response

The location selector was updated.

tokenstring

Public token of the location selector.

urlstring

Public landing page URL.

created_atstring

When the location selector was created, in ISO-8601 format.

updated_atstring

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

fontsizeinteger

Font size used for the page text.

include_zipcodeboolean

When true, the page prompts the user for a zip/postal code.

add_to_wallet_language'en-US' | 'es-ES' | 'es-419' | 'fr-FR'

Locale of the "Add to Wallet" button. One of en-US (English), es-ES (Spanish - Spain), es-419 (Spanish - Latin America), or fr-FR (French).