Referral2

Describes a referral made by a referrer customer.

Note that if multiple people accept a referral from a single link, we will return that as multiple Referral2 entries with the same referral_bhid. These entries will have the same channel and destination.

Kind	Type
Used in	CustomerReferrals2, Refer2

Properties

• referral_bhid bubbleflake required

  Bubblehouse ID of the referral.

• acceptance_bhid bubbleflake optional

  For accepted referrals, a Bubblehouse ID of the particular act of accepting the referral by a single customer.

  Null iff the status is pending or expired.

• 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 ReferralStatus2 required

  Whether a referral is accepted or not, and, if accepted, whether the referrer has received a reward or not.

• link string optional

  A sharable link for this referral.

  Null iff the status is expired.

• sent_at time required

  The time when the referral link has been generated.

• updated_at time required

  The last time the referral status has been updated; matches sent_at for pending referrals.

  This field should be used to sort referrals chronologically.