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.
JCu82f30F1
The email address of the participant.
johndoe@example.com
Referral code of the participant referring.
7ZZp9eBG
Email of the participant referring.
john@ghmail.com
POST /api/v1/addParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"id": "JCu82f30F1",
"email": "johndoe@example.com",
"referredByCode[Optional]": "7ZZp9eBG",
"referredByEmail[Optional]": "john@ghmail.com"
}
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 campaign program details for the given Id.
Campaign Id
GET /api/v1/getCampaign HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
{
"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
}
Get participant details for given campaign Id and email.
Email address of the participant
Campaign Id
GET /api/v1/getParticipant 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
GET /api/v1/getAllParticipants 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
GET /api/v1/getReferrals 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.
JCu82f30F1
The email address of the participant.
johndoe@example.com
Amount spent/paid by participant.
250
POST /api/v1/qualifyParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 78
{
"id": "JCu82f30F1",
"email": "johndoe@example.com",
"amountPaid[Optional]": "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"
}
Validate referrer code for a campaign.
Campaign Id
Code
GET /api/v1/validateCode HTTP/1.1
Host: app.referralrocket.io
Accept: */*
OK
true
Last updated