Add Promotion

Lets you create a promotion for a specific loyalty program.

Request POST Parameters

ParameterDatatypeDescription
id*int
name*stringUnique name of the promotion.
programId*intUnique ID of the loyalty program to associate with the promotion. You can create multiple promotions under a single loyalty program.
startDate*date-timeValidity of the promotion. Pass the date range in startDate and endDate (ISO standard - yyyy-mm-ddThh:mm:ss.s+z).
endDate*date-timeValidity of the promotion. Pass the ISO date range in startDate and endDate (ISO standard - yyyy-mm-ddThh:mm:ss.s+z).
allocatePointsOnstringEnter event action name that generates promotional points. For example, Bill.
identifier*stringUnique identifier of the promotion.
eventName*enumName of the event to associate with the promotion. For example, TRANSACTIONADD, CUSTOMERUPDATE, OfferScan, spinTheWheel, and more.
metadataobjEnter meta information of the promotion in key and value.
allocationActionsobjAllocation attributes like allocation type, expiry days, and more.
qualifyingConditionsarrayArray of different conditions like KPI, parameters, and more.
conditionExpressionstringName of the condition that is passed in qualifyingConditions.
allocationRulearraySet the condition to generate the promotional points.
limitsobjSet the maximum number of promotional points issued to a customer during a specific promotion period. Set the maximum number of times points can be issued to a customer during a promotion period. Set the total number of points that can be generated during a promotion period.
Parameter marked with * is mandatory.
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!