API Endpoint
Add participants to a program by providing the campaign ID and their email address. Optionally, if a 'referredByCode' or 'referredByEmail' is provided, the user will be added as a referral to the participant with the corresponding code.
The ID of the campaign.
JCu82f30F1The email address of the participant.
johndoe@example.comReferral code of the participant referring.
7ZZp9eBGEmail of the participant referring.
john@gmail.comOK
The email address of the participant.
johndoe@example.comThe first name of the participant.
johnThe last name of the participant.
doeThe unique referral code of the participant.
8Mnu09TDThe referral code of the invitee.
7ZZp9eBGThe datetime when participant joined the program.
2023-11-04T15:41:08.828+00:00The campaign Id of the program participant is part of.
JCu82f30F1The unique referral link of the participant.
https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TDThe total referrals made by the participant.
0The total rewards earned by referrals.
0The total referral reward redeemed.
0The total referral balance left.
0The total rewards earned by joining the program.
20The total referee reward redeemed.
0The total referee balance left.
0The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.
falseThe fraud score of the participant. Will be empty for participant created via APIs.
LowNot Found
Internal Server Error
POST /api/v1/addParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"id": "JCu82f30F1",
"email": "johndoe@example.com",
"referredByCode": "7ZZp9eBG",
"referredByEmail": "john@gmail.com"
}{
"email": "johndoe@example.com",
"firstName": "john",
"lastName": "doe",
"referralCode": "8Mnu09TD",
"referredByCode": "7ZZp9eBG",
"createdOn": "2023-11-04T15:41:08.828+00:00",
"campaignId": "JCu82f30F1",
"shareLink": "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD",
"totalReferrals": 0,
"referralReward": 0,
"referralRewardRedeemed": 0,
"referralRewardBalance": 0,
"refereeReward": 20,
"refereeRewardRedeemed": 0,
"refereeRewardBalance": 0,
"rewardEventCompleted": false,
"fraudScore": "Low"
}Get campaign program details for the given Id.
Campaign Id
OK
The ID of the campaign.
JCu82f30F1The name of the campaign.
Q4 Growth ProgramCampaign status. [Active, Pause, End].
ActivePossible values: Campaign creation date.
2023-10-11T00:36:27.753+00:00Campaign end date if set.
2024-10-11T00:36:27.753+00:00Campaign URL.
https://referralrocket.io/campaign?id=JCu82f30F1The flag indicates if the campaign is paused or not.
falseThe flag indicates if the campaign has ended or not.
falseCampaign reward header.
Refer a friend and winCampaign reward description.
Give friends $20 off their first order, and you'll get $20 when they make a purchase.Campaign share widget header.
Refer a friend and winCampaign share widget description.
Use your unique link to give friends $20 off their first order, and you'll get $20 when they make a purchase.Referrer reward value.
20Referee reward value.
20Reward type.
MonetaryTotal participant in the campaign.
8Not Found
GET /api/v1/getCampaign?id=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*
{
"campaignId": "JCu82f30F1",
"campaignName": "Q4 Growth Program",
"status": "Active",
"createdOn": "2023-10-11T00:36:27.753+00:00",
"end": "2024-10-11T00:36:27.753+00:00",
"hostURL": "https://referralrocket.io/campaign?id=JCu82f30F1",
"paused": false,
"ended": false,
"rewardHeader": "Refer a friend and win",
"rewardDescription": "Give friends $20 off their first order, and you'll get $20 when they make a purchase.",
"shareHeader": "Refer a friend and win",
"shareDescription": "Use your unique link to give friends $20 off their first order, and you'll get $20 when they make a purchase.",
"referrerRewardValue": 20,
"refereeRewardValue": 20,
"rewardType": "Monetary",
"participants": 8
}Validate referrer code for a campaign.
Campaign Id
Code
OK
GET /api/v1/validateCode?campaignId=text&code=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
trueGet participant details for given campaign Id and email.
Email address of the participant
Campaign Id
OK
The email address of the participant.
johndoe@example.comThe first name of the participant.
johnThe last name of the participant.
doeThe unique referral code of the participant.
8Mnu09TDThe referral code of the invitee.
7ZZp9eBGThe datetime when participant joined the program.
2023-11-04T15:41:08.828+00:00The campaign Id of the program participant is part of.
JCu82f30F1The unique referral link of the participant.
https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TDThe total referrals made by the participant.
0The total rewards earned by referrals.
0The total referral reward redeemed.
0The total referral balance left.
0The total rewards earned by joining the program.
20The total referee reward redeemed.
0The total referee balance left.
0The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.
falseThe fraud score of the participant. Will be empty for participant created via APIs.
LowGET /api/v1/getParticipant?email=text&id=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
{
"email": "johndoe@example.com",
"firstName": "john",
"lastName": "doe",
"referralCode": "8Mnu09TD",
"referredByCode": "7ZZp9eBG",
"createdOn": "2023-11-04T15:41:08.828+00:00",
"campaignId": "JCu82f30F1",
"shareLink": "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD",
"totalReferrals": 0,
"referralReward": 0,
"referralRewardRedeemed": 0,
"referralRewardBalance": 0,
"refereeReward": 20,
"refereeRewardRedeemed": 0,
"refereeRewardBalance": 0,
"rewardEventCompleted": false,
"fraudScore": "Low"
}Get all participants of a campaign. API returns 20 records at a time. You can adjust the size by passing in the Pageable params.
Campaign Id
OK
The email address of the participant.
johndoe@example.comThe first name of the participant.
johnThe last name of the participant.
doeThe unique referral code of the participant.
8Mnu09TDThe referral code of the invitee.
7ZZp9eBGThe datetime when participant joined the program.
2023-11-04T15:41:08.828+00:00The campaign Id of the program participant is part of.
JCu82f30F1The unique referral link of the participant.
https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TDThe total referrals made by the participant.
0The total rewards earned by referrals.
0The total referral reward redeemed.
0The total referral balance left.
0The total rewards earned by joining the program.
20The total referee reward redeemed.
0The total referee balance left.
0The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.
falseThe fraud score of the participant. Will be empty for participant created via APIs.
LowGET /api/v1/getAllParticipants?id=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
[
{
"email": "johndoe@example.com",
"firstName": "john",
"lastName": "doe",
"referralCode": "8Mnu09TD",
"referredByCode": "7ZZp9eBG",
"createdOn": "2023-11-04T15:41:08.828+00:00",
"campaignId": "JCu82f30F1",
"shareLink": "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD",
"totalReferrals": 0,
"referralReward": 0,
"referralRewardRedeemed": 0,
"referralRewardBalance": 0,
"refereeReward": 20,
"refereeRewardRedeemed": 0,
"refereeRewardBalance": 0,
"rewardEventCompleted": false,
"fraudScore": "Low"
}
]Return all referrals of a participant. The API returns 20 records at a time. You can adjust the size by passing the Pageable params.
Campaign Id
Email address of the participant
OK
The email address of the participant.
johndoe@example.comThe first name of the participant.
johnThe last name of the participant.
doeThe unique referral code of the participant.
8Mnu09TDThe referral code of the invitee.
7ZZp9eBGThe datetime when participant joined the program.
2023-11-04T15:41:08.828+00:00The campaign Id of the program participant is part of.
JCu82f30F1The unique referral link of the participant.
https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TDThe total referrals made by the participant.
0The total rewards earned by referrals.
0The total referral reward redeemed.
0The total referral balance left.
0The total rewards earned by joining the program.
20The total referee reward redeemed.
0The total referee balance left.
0The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.
falseThe fraud score of the participant. Will be empty for participant created via APIs.
LowGET /api/v1/getReferrals?id=text&email=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
[
{
"email": "johndoe@example.com",
"firstName": "john",
"lastName": "doe",
"referralCode": "8Mnu09TD",
"referredByCode": "7ZZp9eBG",
"createdOn": "2023-11-04T15:41:08.828+00:00",
"campaignId": "JCu82f30F1",
"shareLink": "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD",
"totalReferrals": 0,
"referralReward": 0,
"referralRewardRedeemed": 0,
"referralRewardBalance": 0,
"refereeReward": 20,
"refereeRewardRedeemed": 0,
"refereeRewardBalance": 0,
"rewardEventCompleted": false,
"fraudScore": "Low"
}
]Mark qualifying event complete for a participant. Marking a qualifying event complete for a participant will result in the referrer being eligible for a reward. Only referred participants can be can complete a qualifying event and hence marked as qualified.
The ID of the campaign.
JCu82f30F1The email address of the participant.
johndoe@example.comAmount spent/paid by participant.
250OK
The email address of the participant.
johndoe@example.comThe first name of the participant.
johnThe last name of the participant.
doeThe unique referral code of the participant.
8Mnu09TDThe referral code of the invitee.
7ZZp9eBGThe datetime when participant joined the program.
2023-11-04T15:41:08.828+00:00The campaign Id of the program participant is part of.
JCu82f30F1The unique referral link of the participant.
https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TDThe total referrals made by the participant.
0The total rewards earned by referrals.
0The total referral reward redeemed.
0The total referral balance left.
0The total rewards earned by joining the program.
20The total referee reward redeemed.
0The total referee balance left.
0The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.
falseThe fraud score of the participant. Will be empty for participant created via APIs.
LowPOST /api/v1/qualifyParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"id": "JCu82f30F1",
"email": "johndoe@example.com",
"amountPaid": "250"
}OK
{
"email": "johndoe@example.com",
"firstName": "john",
"lastName": "doe",
"referralCode": "8Mnu09TD",
"referredByCode": "7ZZp9eBG",
"createdOn": "2023-11-04T15:41:08.828+00:00",
"campaignId": "JCu82f30F1",
"shareLink": "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD",
"totalReferrals": 0,
"referralReward": 0,
"referralRewardRedeemed": 0,
"referralRewardBalance": 0,
"refereeReward": 20,
"refereeRewardRedeemed": 0,
"refereeRewardBalance": 0,
"rewardEventCompleted": false,
"fraudScore": "Low"
}Last updated