Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 2.72 KB

NewReward.md

File metadata and controls

22 lines (15 loc) · 2.72 KB

NewReward

Properties

Name Type Description Notes
name String The name of the reward.
apiName String A unique identifier used to reference the reward in API integrations.
description String A description of the reward. [optional]
applicationIds List<Long> The IDs of the Applications this reward is connected to. Note: Currently, a reward can only be connected to one Application.
sandbox Boolean Indicates if this is a live or sandbox reward. Rewards of a given type can only be connected to Applications of the same type.
eligibilityConditions Rule [optional]
rule Rule [optional]
bindings List<Binding> A list of named variables created before the reward's rules are evaluated. Each binding pairs a name with a talang expression. The expression is evaluated once and its result is available by name in any rule condition or effect. Bindings must be defined outside of individual rules. [optional]
pointsRequired List<RewardPointsRequired> The loyalty points required to activate the reward. Each object defines the specific loyalty program and subledger from which points are deducted when activating the reward. Note: When creating a reward, the `id` of each entry is ignored and a new entry is always created. [optional]
validityDuration String The duration for which the customer rewards unlocked from this reward remain active, relative to when the customer reward was unlocked. The time format is an integer followed by one letter indicating the time unit. Examples: `5D`, `7W`, `10M`, `15Y`. Available units: - `D`: days - `W`: weeks - `M`: months - `Y`: years You can round certain units up or down: - `_D` for rounding down days only. Signifies the start of the day. - `_U` for rounding up days, weeks, months and years. Signifies the end of the day, week, month or year. This field cannot be used in combination with `expiryDate`. If both `validityDuration` and `expiryDate` are not set, customer rewards have unlimited validity. [optional]
expiryDate OffsetDateTime Expiry date of the customer rewards unlocked from this reward. Customer rewards never expire if this is omitted and `validityDuration` is not set. Note: - The date must be in the future. - This field cannot be used in combination with `validityDuration`. [optional]