Loyalty Automatic Reward Rule
An Automatic Reward Rule automatically issues a Loyalty Reward to a member's Loyalty Enrollment whenever the rule's condition is met. It removes the need for program operators to manually issue rewards in response to member activity — a common use case is auto-exchanging points for a reward as soon as the balance is high enough.
Rules are evaluated after any event that changes an Enrollment's point balance (transaction claim, retro-claim, or manual point credit). When the condition holds, the linked reward is issued and its point cost is deducted from the Enrollment; the condition is then re-evaluated against the new balance, so a single triggering event may issue the same reward more than once if the balance still supports it.
The linked reward must belong to the same Loyalty Program as the rule. For
sufficient_point_balance rules, the reward's point_value must be at least
1 — a 0-point reward would issue indefinitely and is rejected on save. If the
reward is later archived or its point value drops to 0, the automatic reward
process silently skips the rule at evaluation time.
When updating, already existing fields omitted from the payload will generally not be deleted unless otherwise specified.
- issuanceenum
_condition _type const:sufficient_point_balancerequired - nameType: stringrequired
- programType: integer
_id read-onlyrequiredInteger numbers.
- rewardType: integer
_id requiredID of the
loyalty_rewardto issue when this rule's condition is met. - createdType: stringFormat: date-time
_at read-onlythe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- idType: integerread-only
Integer numbers.
- rewardType: integer
_point _value read-onlySnapshot of the linked reward's current
point_valueat read time. - statusType: stringenumread-only
The current status of the Automatic Reward Rule.
valuespendingactivesuspendedarchived - updatedType: stringFormat: date-time
_at read-onlythe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z