Referral Reward Object


Properties
idstringRead-onlyformat GUID

Referral reward ID.


revisionintegerformat int64

Revision number, which increments by 1 each time the referral reward is updated. To prevent conflicting changes, the current revision must be passed when updating the referral reward.


createdDatestringRead-onlyformat date-time

Date and time the referral reward was created.


updatedDatestringRead-onlyformat date-time

Date and time the referral reward was last updated.


rewardTypestring

Type of reward given.

Possible values:

  • UNKNOWN: Unknown reward.
  • COUPON: A loyalty coupon is given.
  • LOYALTY_POINTS: Loyalty points are awarded.
  • NOTHING: No reward is given.

ONE OF:

rewardedReferringCustomerIdstringRead-onlyformat GUID

ID of the referring customer who received the reward.


rewardedReferredFriendIdstringRead-onlyformat GUID

ID of the referred friend who received the reward.


ONE OF:

couponCoupon

Details of a coupon reward. Present when reward_type is COUPON.


loyaltyPointsLoyaltyPoints

Details of a loyalty points reward. Present when reward_type is LOYALTY_POINTS.

Did this help?