Comment on page
Endpoint Reference
Locations where you can find most of the required parameters:
Path Parameters | Location |
api_token | ReferralHero dashboard > Account > API |
name | ReferralHero dashboard > Campaign name |
uuid | ReferralHero dashboard > Campaign > Installation > Instructions The 12-letter id that starts with ‘MF’ in the Tracking Code, e.g. MF078d000987 |
post
https://app.referralhero.com/api/v2
/lists
Create a new list
get
https://app.referralhero.com/api/v2
/lists
Retrieve all lists
get
https://app.referralhero.com/api/v2
/lists/:uuid/leaderboard
Get List Leaderboard
get
https://app.referralhero.com/api/v2
/lists/:uuid/bonuses
Get list rewards
Locations where you can find most of the required parameters:
Path Parameters | Location |
api_token | ReferralHero dashboard > Account > API |
uuid | ReferralHero dashboard > Campaign > Installation > Instructions The 12-letter id that starts with ‘MF’ in the Tracking Code, e.g. MF078d000987 |
email | The email of the subscriber |
domain | ReferralHero dashboard > Campaign > Options > Default Referral Link |
subscriber_id | ReferralHero dashboard > Campaign > Subscribers |
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers
Add a subscriber
Note for Web Integrations:
When deciding between using our Javascript Web API or REST API to interact with ReferralHero, it is generally advisable to 'add a subscriber' using the Javascript Web API as you will take advantage of our powerful global tracking script and cookie. Once a subscriber is added to our database, you can manage that subscriber and campaign more freely using either the Javascript Web API or REST API.
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/track_referral_conversion_event
Track referral conversion event
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/confirm
Confirm referral
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Update a subscriber
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/add_points
Add points to a subscriber
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/promote
Promote a subscriber
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/unlock_promoted_reward
Trigger manual rewards
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers
Retrieve all subscribers from a list
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Retrieve subscriber by ID
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/retrieve_by_email
Retrieve subscriber by email
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/referred
Retrieve all referrals of a subscriber
get
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id/rewards
Retrieve all rewards unlocked by a subscriber
delete
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/:subscriber_id
Delete a subscriber
post
https://app.referralhero.com/api/v2
/lists/:uuid/subscribers/update_reward_status
Update reward status by reward_id
post
https://app.referralhero.com/api/v2
/lists/:uuid/coupon_groups
Create coupon group
post
https://app.referralhero.com/api/v2
/lists/:uuid/coupons
Create coupons
get
https://app.referralhero.com/api/v2
/lists/:uuid/coupon_groups
Retrieve all coupon groups
get
https://app.referralhero.com/api/v2
/lists/:uuid/coupon_groups/:id
Retrieve coupons
Last modified 27d ago