v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Wallet Campaign API

Update a wallet item

put/companies/{company_key}/campaigns/wallet/{wallet_id}/items/{wallet_item_id}

Path parameters

company_keystring required

wallet_idstring required

The wallet_id is the SmartLink token for a campaign.

wallet_item_idstring required

<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_item_id, 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 being updated.</div></div>

Headers

X-API-Versionstring

Content-Typestring required

Request body

tokensobject

List of key/value pairs of item specific data that can be used to personalize the item.

Response

Successful response

wallet_item_idstring

Unique Wallet Item ID that was specified at creation. This can be system generated or customer supplied in the creation URL.

group_codestring

Optional string value to indicate groups of related Wallet items. Can be used for targeted messaging.

activeboolean

TRUE if wallet item currently installed on person’s device.

tokensobject

Key/value pairs of item-specific data used to personalize this pass (referenced by personalization tags in the template).

providerstring

The wallet platform this item was issued to, for example passbook (Apple Wallet) or google_wallet (Google Wallet).

created_atstring

When the wallet item was created, in ISO-8601 format.

updated_atstring

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

urlstring

A reference URL to this wallet item, as a relative URL on the API domain.