Create Loyalty Promotion for UCC

post

https://{host}/api_gateway/loyalty/v1/programs/{programId}/createPromotion/{promotionType}

Lets you create a promotion for UCC a specific loyalty program.

Path Params

programId

int64

required

Unique ID of the loyalty program associated with the promotion.

promotionType

string

required

Type of promotion. Supported values SIMPLE, RANGE, KEYWORD

Body Params

int32

The ID of the ruleset. Set the value to -1. This indicates that a new promotion request is being created.

name

string

required

Unique name for the ruleset

programId

int32

required

Unique ID of the loyalty program to associate with the promotion. You can create multiple promotions under a single loyalty program.

startDate

date

required

Validity of the promotion. Pass the date range in startDate and endDate (ISO standard - yyyy-mm-ddThh:mm:ss.s+z).

endDate

date

required

Validity of the promotion. Pass the ISO date range in startDate and endDate (ISO standard - yyyy-mm-ddThh:mm:ss.s+z).

allocatePointsOn

string

Enter event action name that generates promotional points. For example, Bill

identifier

string

required

Unique identifier of the promotion

eventName

string

enum

required

Name of the event to associate with the promotion. For example, TRANSACTIONADD, CUSTOMERUPDATE, OfferScan, spinTheWheel, and more

Allowed:

qualifyingConditions

array of strings

Array of different conditions like KPI, parameters, and more.

qualifyingConditions

conditionExpression

string

Name of the condition that is passed in qualifyingConditions.

allocationRule

array of strings

Set the condition to generate the promotional points.

allocationRule

contextID

int32

required

Unique ID of the promotion. Refer to the documentation on promotion IDs for more information.

orgID

int32

required

Unique ID of the organization

contextType

string

required

The type of context. Set to program.

endpointName

string

required

Set to POINTSENGINE_ENDPOINT

type

string

required

Type of ruleset.

startDate , endDate

string

required

Format in Epoch time (ex. 1726207950)

active

boolean

required

Status of the promotion. Set to true when creating a promotion for the first time

rules

array of strings

required

The rules defined for the promotion

rules*

-id

int32

The unique identifier for the rule.

-exp

boolean

required

Enable rule expression. Rule expressions are conditions that determine whether a statement is true or false. Refer to rule writing for more information.

-expJSON

string

required

The rule expression in JSON format.

-isActive

boolean

required

Indicates whether the rule is active. Set to true when creating a promotion for the first time

-priority

int32

The priority of the rule.

-startDate

int32

The start date of the rule. ISO 8601 Date Format

-endDate

int32

The end date of the rule. ISO 8601 Date Format

-createdOn

int32

The timestamp when the rule was created. ISO 8601 Date Format

--name

string

required

Name of the action

--mandatoryPropertiesValues

string

required

As a set of key pair values eg: "key": "ProRateOnSourceValue", "value": "EVENT_DEFAULT_VALUE"

Response

200200