Program Object


Properties
createdDatestringRead-onlyformat date-time

Date and time the program was created.


emailsEmails

Configures email notifications for the referral program.


namestringminLength 2maxLength 50

Referral program name.


premiumFeaturesPremiumFeaturesRead-only

Indicates which premium features are available for the current account.


referredFriendRewardReward

Reward configuration for the referred friend. Specifies the reward given to a new customer who was referred to the business.


referringCustomerRewardReward

Reward configuration for the referring customer. Specifies the reward given to an existing customer who referred a new customer to the business.


revisionstringimmutableformat int64

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


statusstringRead-only

successfulReferralActionsArray <string>maxItems 100

List of actions that complete a referral. For an action to be considered successful, the referred friend must place and pay for an item.


updatedDatestringRead-onlyformat date-time

Date and time the program was last updated.

Did this help?