Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Create Loyalty Program

Create a new loyalty program.

Args:

  • data: Payload to create the program.
  • user: The user creating the program, derived from the current session.

Returns:

  • JSON response with the created program details or an error message.
post/v2/programs

Headers

authorizationstring nullable

Request body

passTypeIdentifierstring required
schema'stampCard' | 'tieredMembership' | 'specialOffers' | 'custom'
programType'loyalty' | 'giftcard'
namestring required
descriptionstring nullable
languagestring nullable
countrystring nullable
companystring nullable
addressstring nullable
websitestring uri nullable
phonestring nullable
termsstring nullable
pointsAddEmailinteger nullable
pointsAddPhoneinteger nullable
pointsInstallPassinteger nullable
pointsScanPassinteger nullable
dynamicScanPointsboolean nullable
pointsReferralinteger nullable
referralRequiredPointsinteger nullable
scannerType'Browser' | 'PassVerifier' | 'CodeReadr' | 'None'
customPointsChangeMessagestring nullable
disableCustomPointsChangeMessageboolean nullable
customPointNamestring nullable
customPointsNamestring nullable
requiredFieldsstring[]
retention_period_daysinteger

Days to retain deleted data (0-365)

Response

Successful Response

{"stackTrail":"paths:/v2/programs:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}