Creates a reward that customers can redeem with loyalty points.
When a customer redeems a reward, a loyalty coupon is created
based on the specifications detailed in the discountAmount
or couponReward
fields. The customer can
then use this coupon to receive the discount. Note that while the Rewards API uses coupon scopes and specifications,
no coupon is actually created until a customer redeems a reward with points.
See the Coupons API for more information about coupons. You can't update the type
of reward after it's created.
A reward's active
status defaults to false
. To make the reward available to customers,
either set the active
field to true
during creation or call Update Reward
to change the status.
To customize a reward for each loyalty tier, use configsByTier
.
This allows you to specify the amount of the earned discount, the cost in loyalty points
to redeem the reward, and the tier to which this configuration applies. Each tier requires its own
configsByTier
configuration. To create a reward that's available to loyalty accounts in the base tier,
leave the tierId
field empty. See the Tiers API for more information on tiers.
You can only call this method when authenticated as a Wix app or Wix user identity.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.