Sign in

v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Create Loyalty Program Offer

Create Offer

Create a new offer within a specific loyalty program.

  • programId: The unique identifier of the loyalty program.
  • data: The data for the new offer.
  • user: The current active user making the request.
  • Returns: The details of the newly created offer.
post/v2/loyalty/programs/{programId}/offers

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

namestring required
descriptionstring nullable
startDatestring date-time nullable
endDatestring date-time nullable
autoClaimboolean nullable
autoClaimOverwriteboolean nullable
notifyboolean nullable
notifyMessagestring nullable
pointsMininteger nullable
pointsMaxinteger nullable
pointsCostinteger nullable
limitPerCustomerinteger nullable
availabilityCountinteger nullable
valuenumber nullable
currencystring nullable
type'fixed' | 'percent' | 'other'
categoriesstring nullable
productsstring nullable
priceRule'min' | 'max' | 'none'

Response

Successful Response

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