Program Object


Properties
namestringminLength 2maxLength 50

Referral program name.


statusstringRead-only

revisionintegerformat 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.


createdDatestringRead-onlyformat date-time

Date and time the program was created.


updatedDatestringRead-onlyformat date-time

Date and time the program was last updated.


referredFriendRewardReferredFriendReward

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


referringCustomerRewardReferringCustomerReward

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


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.

Possible values:

  • UNKNOWN: Action is unknown.
  • STORE_ORDER_PLACED: Referred friend ordered and paid for an order in a store.
  • PLAN_ORDERED: Referred friend ordered and paid for a plan.
  • TICKET_ORDERED: Referred friend ordered and paid for a ticket.
  • SESSION_BOOKED: Referred friend booked and paid for a session.
  • RESTAURANT_ORDER_PLACED: Referred friend placed and paid for a restaurant order.

emailsEmails

Configures email notifications for the referral program.


premiumFeaturesPremiumFeaturesRead-only

Indicates which premium features are available for the current account.

Did this help?