Skip to main content
POST
Create new pass

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Body

application/json

Data required to create a pass.

walletType
enum<string>
required

Target wallet platform for the pass

Available options:
APPLE_WALLET,
GOOGLE_WALLET
programId
string
required

ID of the program to create a pass for

Minimum string length: 1
creationSource
object

Detailed tracking of how the pass was created

templateOverrides
object

Template overrides for dynamic pass customization based on business logic (e.g., member tiers, promotions). All fields are optional.

notificationMessage
string

Message shown when the pass is updated (wallet push / pass refresh)

externalId
string

External reference ID from CRM or other systems

semanticTagOverrides
object

Semantic tags for Apple Wallet passes: seating, flight, event and location details that Wallet and Siri use for suggestions. All fields are optional; send the ones that apply to your pass type.

membershipStatus
string

Merchant-defined account status (e.g., "Active", "Suspended", "On Hold")

Maximum string length: 255
externalReference
string

Additional external reference for integration with external systems

Maximum string length: 200
payload
string

NFC or QR payload (defaults to pass ID if not provided)

loyaltyState
object

Loyalty program state information

activationDate
string<date-time>

Date when the pass becomes active

customer
object

Optional customer information for personalization

expirationDate
string<date-time>

Date when the pass expires

Response

201 response

Response envelope carrying a pass.

data
PassModel · object
required

Digital pass issued to a customer.

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$