Objects
List
Your ReferralHero list, also known as your campaign, is where you store and manage all of your subscribers. Your subscribers will always be added to one list and can't be transferred to another list.
Attributes | ||
uuid |
| The unique identifier of the campaign |
name |
| The campaign name |
subscribers |
| The total subscribers count |
created_at |
| Unix timestamp (expressed in UTC) of when the list has been created. |
Subscriber
A subscriber is a person who is added to one of your lists. Subscribers belong to precisely one list and can't be transferred.
Attributes | ||
id |
| The unique identifier of the subscriber |
name |
| The name of the subscriber |
| The email of the subscriber | |
extra_field |
| The extra field value of the subscriber |
extra_field_2 |
| The extra field 2 value of the subscriber |
code |
| The referral code of the subscriber |
position |
| The position of the subscriber in the list (if applicable) |
referred |
|
|
referral_value | number | The monetay value of the referral. |
referral_category | string | The type of subscriber. Useful for creating reports or segmenting subscribers. |
transaction_id | string | The unique ID of the transaction. Useful when tracking referrals for purchases. |
referred_by |
| An object containing the subscriber's referrer information. |
people_referred |
| The total number of referrals of the subscriber. |
level_2_confirmed_referrals |
| The total number of level 2 confirmed referrals of the subscriber. |
level_3_confirmed_referrals |
| The total number of level 3 confirmed referrals of the subscriber. |
promoted |
|
|
promoted_at |
| Unix timestamp (expressed in UTC) of when the subscriber has been promoted. |
verified |
|
|
verified_at |
| Unix timestamp (expressed in UTC) of when the subscriber has verified their email address. |
risk_level |
| Subscriber's fraudulence level expressed as an integer from 0 (none) to 5 (extremely likely) |
points |
| The number of points of the subscriber |
host |
| Url used to generate the referral link. |
source |
| The source of the subscriber. |
device |
| The decide used by the subscriber to sign up. |
created_at |
| The date the participant was added to the campaign (UTC milliseconds) |
updated_at |
| Unix timestamp (expressed in UTC) of the last time the subscriber has been updated. |
Reward
The Reward
Object contains detailed reward information about a single reward that was set up for a campaign.
Attributes | ||
title |
| The name of the reward |
description |
| The description of the reward |
referrals |
| The number of referrals needed to win this reward |
Last updated