Skip to main content
POST
Create new program

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 new program.

name
string
required

Internal program name (2-100 characters)

Required string length: 2 - 100
type
enum<string>
required

Pass type determining wallet style and functionality

Available options:
LOYALTY_CARD,
STAMP_CARD,
ID_CARD,
BOARDING_PASS,
EVENT_TICKET,
COUPON,
STORE_CARD,
GIFT_CARD,
GENERIC_CARD
country
string

ISO 3166-1 alpha-2 country code for the program operating country

Pattern: ^[A-Z]{2}$
merchantId
string

ID of the merchant to associate the program with (optional for company-wide programs)

displayName
string

Public-facing program name (max 100 characters)

Maximum string length: 100
description
string

Program description shown to customers (max 500 characters)

Maximum string length: 500
productType
enum<string>

Product tier (ENTRY: basic features, LOYALTY: advanced features)

Available options:
ENTRY,
LOYALTY

Response

201 response

Response envelope carrying a program.

data
ProgramModel · object
required

Pass program configuration.

requestId
string
required

Unique request identifier for debugging

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