Sign in

v1

latestOpenAPI 3.0.02026-07-267581167.5 KB
Wallet Campaign API

Create a wallet campaign

Create a new mobile wallet campaign. The campaign type determines the kind of pass it issues (offer, loyalty, or event_ticket) and cannot be changed after creation.

post/companies/{company_key}/campaigns/wallet

Path parameters

company_keystring 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> 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 campaign being created.</div></div>

Headers

X-API-Versionstring
Content-Typestring required

Request body

Example request

{
  "campaign": {
    "name": "Spring Sale",
    "description": "20% off all items this spring",
    "type": "offer",
    "expiration_date": "2026-06-30T23:59:59Z",
    "redirect_link": "https://example.com/expired"
  }
}

Response

The wallet campaign was created.

wallet_idstring

The wallet_id is the SmartLink token for the campaign. Use it to identify the campaign in all other Wallet API calls.

namestring

Descriptive name of the mobile wallet campaign.

descriptionstring

Optional longer description of the campaign. Returned only when set.

type'offer' | 'loyalty' | 'event_ticket'

The kind of pass this campaign issues. One of offer (coupon), loyalty (store/loyalty card), or event_ticket.

smartlink_urlstring

Public SmartLink URL used to distribute the pass to end users (the "Add to Wallet" link).

urlstring

REST API reference to this wallet campaign, as a relative URL on the API domain.

redirect_linkstring

URL that end users are redirected to after the campaign has expired. Returned only when set.

expiration_datestring

When the campaign expires, in ISO-8601 format. Returned only when set.

ignore_unsecure_paramsboolean

When true, only values from a signed (JWT) payload are trusted when personalizing passes. Returned only when configured.

created_atstring

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

updated_atstring

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