Referral2

Describes one referral in the customer's referral history.

This is the same shape used by the customer-facing referral history block.

If multiple people use the same shared referral link, the response can contain multiple Referral2 entries with the same referral_bhid.

Kind	Type
Used in	CustomerReferrals2, Refer2

Properties

• referral_bhid bubbleflake required

  Bubblehouse ID of the original referral send.

• acceptance_bhid bubbleflake optional

  Bubblehouse ID of this specific referral result.

  Null when the referral has only been sent and has not yet been tied to a specific referred customer.

• channel ReferralChannel1 required

  The method used to deliver the referral link (or code) to the target person or audience.

• destination string optional

  An email address for the email channel. Could be used by other channels in the future when relevant; currently the SMS method does not record phone numbers, and social methods do not record social accounts.

• status ReferralStatus3 required

  Current status of the referral.

• link string optional

  The current shareable referral link.

• sent_at time required

  The time when the referral was first sent.

• accepted_at time optional

  The time when this referral was first tied to a specific referred customer.

  For qualified referrals this is the time when that referred customer first appeared for the referral. Null when the referral has only been sent and has not yet been tied to a specific referred customer.

• reward_pts integer optional

  Points earned by the referrer for this row.

• reward_pts_value monetary optional

  Monetary value of reward_pts in the venue currency.

• reward_amount monetary optional

  Direct monetary reward earned by the referrer for this row.

• coupon_code string optional

  Coupon code earned by the referrer for this row, when applicable.