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
Example
Attributes

Attributes

uuid

string

The unique identifier of the campaign

name

string

The campaign name

subscribers

integer

The total subscribers count

created_at

timestamp

Unix timestamp (expressed in UTC) of when the list has been created.

Example
{
"uuid": "MFae3b657302",
"name": "My amazing sweepstake",
"created_at": 1487347070,
"subscribers": 0
}

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
Example
Attributes

Attributes

id

integer

The unique identifier of the subscriber

name

string

The name of the subscriber

email

string

The email of the subscriber

extra_field

string

The extra field value of the subscriber

extra_field_2

string

The extra field 2 value of the subscriber

code

string

The referral code of the subscriber

position

string

The position of the subscriber in the list (if applicable)

referred

boolean

True if the subscriber has been referred, false if not.

referred_by

object

An object containing the subscriber's referrer information.

people_referred

integer

The total number of referrals of the subscriber.

promoted

boolean

True is the subscriber is in the "winners" list, false if not.

promoted_at

timestamp

Unix timestamp (expressed in UTC) of when the subscriber has been promoted.

verified

boolean

True if the subscriber has verified their email address, false if not.

verified_at

timestamp

Unix timestamp (expressed in UTC) of when the subscriber has verified their email address.

risk_level

integer

Subscriber's fraudulence level expressed as an integer from 0 (none) to 5 (extremely likely)

points

integer

The number of points of the subscriber

host

string

Url used to generate the referral link.

source

string

The source of the subscriber.

device

string

The decide used by the subscriber to sign up.

created_at

timestamp

The date the participant was added to the campaign (UTC milliseconds)

updated_at

timestamp

Unix timestamp (expressed in UTC) of the last time the subscriber has been updated.

Example
{
"id": "sub_1564fabfe0bb",
"name": "John Doe",
"email": "john.doe@gmail.com",
"extra_field": "+1 228374652",
"extra_field_2": "USA",
"code": "266-18bc5ad8",
"position": null,
"referred": false,
"referred_by": {
"id": "sub_42c5283fd538",
"name": null,
"email": "eee@ll.com",
"code": "208-a4ff5779",
"people_referred": 1,
"points": 2
},
"people_referred": 0,
"promoted": false,
"promoted_at": null,
"verified": true,
"verified_at": 1491451155,
"points": 1,
"risk_level": 3,
"host": "https://referralhero.com",
"source": null,
"device": null,
"created_at": 1491451155,
"last_updated_at": 1491451155
}

Reward

The Reward Object contains detailed reward information about a single reward that was set up for a campaign.

Attributes
Example
Attributes

Attributes

title

string

The name of the reward

description

string

The description of the reward

referrals

integer

The number of referrals needed to win this reward

Example
{
"title": "30% discount on our Pro Plan",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"referrals": 2
}