Referral2 - Bubblehouse API

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.

Properties

referral_bhidbubbleflakerequired
Bubblehouse ID of the referral.
acceptance_bhidbubbleflakeoptional
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.
channelReferralChannel1required
The method used to deliver the referral link (or code) to the target person or audience.
destinationstringoptional
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.
statusReferralStatus2required
Whether a referral is accepted or not, and, if accepted, whether the referrer has received a reward or not.
linkstringoptional
A sharable link for this referral.
Null iff the status is expired.
sent_attimerequired
The time when the referral link has been generated.
updated_attimerequired
The last time the referral status has been updated; matches sent_at for pending referrals.
This field should be used to sort referrals chronologically.