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.

POSThttps://app.referralrocket.io/api/v1/addParticipant

Body

idstring

The ID of the campaign.

Example: "JCu82f30F1"

emailstring

The email address of the participant.

Example: "johndoe@example.com"

referredByCode[Optional]string

Referral code of the participant referring.

Example: "7ZZp9eBG"

referredByEmail[Optional]string

Email of the participant referring.

Example: "john@ghmail.com"

Response

Body

emailstring

The email address of the participant.

Example: "johndoe@example.com"

firstNamestring

The first name of the participant.

Example: "john"

lastNamestring

The last name of the participant.

Example: "doe"

referralCodestring

The unique referral code of the participant.

Example: "8Mnu09TD"

referredByCodestring

The referral code of the invitee.

Example: "7ZZp9eBG"

createdOnstring

The datetime when participant joined the program.

Example: "2023-11-04T15:41:08.828+00:00"

campaignIdstring

The campaign Id of the program participant is part of.

Example: "JCu82f30F1"

shareLinkstring

The unique referral link of the participant.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD"

totalReferralsint

The total referrals made by the participant.

Example: 0

referralRewardint

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedint

The total referral reward redeemed.

Example: 0

referralRewardBalanceint

The total referral balance left.

Example: 0

refereeRewardint

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedint

The total referee reward redeemed.

Example: 0

refereeRewardBalanceint

The total referee balance left.

Example: 0

rewardEventCompletedBoolean

The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.

Example: false

fraudScorestring

The fraud score of the participant. Will be empty for participant created via APIs.

Example: "Low"

Request

const response = await fetch('https://app.referralrocket.io/api/v1/addParticipant', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

GEThttps://app.referralrocket.io/api/v1/getCampaign

Query parameters

Response

Body

campaignIdstring

The ID of the campaign.

Example: "JCu82f30F1"

campaignNamestring

The name of the campaign.

Example: "Q4 Growth Program"

statusstring

Campaign status. [Active, Pause, End].

Example: "Active"

createdOnstring

Campaign creation date.

Example: "2023-10-11T00:36:27.753+00:00"

Endstring

Campaign end date if set.

Example: "2024-10-11T00:36:27.753+00:00"

hostURLstring

Campaign URL.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1"

pausedBoolean

The flag indicates if the campaign is paused or not.

Example: false

endedBoolean

The flag indicates if the campaign has ended or not.

Example: false

rewardHeaderstring

Campaign reward header.

Example: "Refer a friend and win"

rewardDescriptionstring

Campaign reward description.

Example: "Give friends $20 off their first order, and you'll get $20 when they make a purchase."

shareHeaderstring

Campaign share widget header.

Example: "Refer a friend and win"

shareDescriptionstring

Campaign share widget description.

Example: "Use your unique link to give friends $20 off their first order, and you'll get $20 when they make a purchase."

referrerRewardValueInt

Referrer reward value.

Example: 20

refereeRewardValueInt

Referee reward value.

Example: 20

rewardTypeString

Reward type.

Example: "Monetary"

participantsInt

Total participant in the campaign.

Example: 8

Request

const response = await fetch('https://app.referralrocket.io/api/v1/getCampaign?id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

GEThttps://app.referralrocket.io/api/v1/getParticipant

Query parameters

Response

Body

emailstring

The email address of the participant.

Example: "johndoe@example.com"

firstNamestring

The first name of the participant.

Example: "john"

lastNamestring

The last name of the participant.

Example: "doe"

referralCodestring

The unique referral code of the participant.

Example: "8Mnu09TD"

referredByCodestring

The referral code of the invitee.

Example: "7ZZp9eBG"

createdOnstring

The datetime when participant joined the program.

Example: "2023-11-04T15:41:08.828+00:00"

campaignIdstring

The campaign Id of the program participant is part of.

Example: "JCu82f30F1"

shareLinkstring

The unique referral link of the participant.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD"

totalReferralsint

The total referrals made by the participant.

Example: 0

referralRewardint

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedint

The total referral reward redeemed.

Example: 0

referralRewardBalanceint

The total referral balance left.

Example: 0

refereeRewardint

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedint

The total referee reward redeemed.

Example: 0

refereeRewardBalanceint

The total referee balance left.

Example: 0

rewardEventCompletedBoolean

The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.

Example: false

fraudScorestring

The fraud score of the participant. Will be empty for participant created via APIs.

Example: "Low"

Request

const response = await fetch('https://app.referralrocket.io/api/v1/getParticipant?email=text&id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

GEThttps://app.referralrocket.io/api/v1/getAllParticipants

Query parameters

Response

Body

emailstring

The email address of the participant.

Example: "johndoe@example.com"

firstNamestring

The first name of the participant.

Example: "john"

lastNamestring

The last name of the participant.

Example: "doe"

referralCodestring

The unique referral code of the participant.

Example: "8Mnu09TD"

referredByCodestring

The referral code of the invitee.

Example: "7ZZp9eBG"

createdOnstring

The datetime when participant joined the program.

Example: "2023-11-04T15:41:08.828+00:00"

campaignIdstring

The campaign Id of the program participant is part of.

Example: "JCu82f30F1"

shareLinkstring

The unique referral link of the participant.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD"

totalReferralsint

The total referrals made by the participant.

Example: 0

referralRewardint

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedint

The total referral reward redeemed.

Example: 0

referralRewardBalanceint

The total referral balance left.

Example: 0

refereeRewardint

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedint

The total referee reward redeemed.

Example: 0

refereeRewardBalanceint

The total referee balance left.

Example: 0

rewardEventCompletedBoolean

The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.

Example: false

fraudScorestring

The fraud score of the participant. Will be empty for participant created via APIs.

Example: "Low"

Request

const response = await fetch('https://app.referralrocket.io/api/v1/getAllParticipants?id=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

GEThttps://app.referralrocket.io/api/v1/getReferrals

Query parameters

Response

Body

emailstring

The email address of the participant.

Example: "johndoe@example.com"

firstNamestring

The first name of the participant.

Example: "john"

lastNamestring

The last name of the participant.

Example: "doe"

referralCodestring

The unique referral code of the participant.

Example: "8Mnu09TD"

referredByCodestring

The referral code of the invitee.

Example: "7ZZp9eBG"

createdOnstring

The datetime when participant joined the program.

Example: "2023-11-04T15:41:08.828+00:00"

campaignIdstring

The campaign Id of the program participant is part of.

Example: "JCu82f30F1"

shareLinkstring

The unique referral link of the participant.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD"

totalReferralsint

The total referrals made by the participant.

Example: 0

referralRewardint

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedint

The total referral reward redeemed.

Example: 0

referralRewardBalanceint

The total referral balance left.

Example: 0

refereeRewardint

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedint

The total referee reward redeemed.

Example: 0

refereeRewardBalanceint

The total referee balance left.

Example: 0

rewardEventCompletedBoolean

The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.

Example: false

fraudScorestring

The fraud score of the participant. Will be empty for participant created via APIs.

Example: "Low"

Request

const response = await fetch('https://app.referralrocket.io/api/v1/getReferrals?id=text&email=text&page=%5Bobject+Object%5D', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

POSThttps://app.referralrocket.io/api/v1/qualifyParticipant

Body

idstring

The ID of the campaign.

Example: "JCu82f30F1"

emailstring

The email address of the participant.

Example: "johndoe@example.com"

amountPaid[Optional]string

Amount spent/paid by participant.

Example: "250"

Response

Body

emailstring

The email address of the participant.

Example: "johndoe@example.com"

firstNamestring

The first name of the participant.

Example: "john"

lastNamestring

The last name of the participant.

Example: "doe"

referralCodestring

The unique referral code of the participant.

Example: "8Mnu09TD"

referredByCodestring

The referral code of the invitee.

Example: "7ZZp9eBG"

createdOnstring

The datetime when participant joined the program.

Example: "2023-11-04T15:41:08.828+00:00"

campaignIdstring

The campaign Id of the program participant is part of.

Example: "JCu82f30F1"

shareLinkstring

The unique referral link of the participant.

Example: "https://referralrocket.io/campaign?id=JCu82f30F1&referralCode=8Mnu09TD"

totalReferralsint

The total referrals made by the participant.

Example: 0

referralRewardint

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedint

The total referral reward redeemed.

Example: 0

referralRewardBalanceint

The total referral balance left.

Example: 0

refereeRewardint

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedint

The total referee reward redeemed.

Example: 0

refereeRewardBalanceint

The total referee balance left.

Example: 0

rewardEventCompletedBoolean

The Boolean flag to indicate if the participant fulfilled the event required to earn the reward.

Example: false

fraudScorestring

The fraud score of the participant. Will be empty for participant created via APIs.

Example: "Low"

Request

const response = await fetch('https://app.referralrocket.io/api/v1/qualifyParticipant', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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"
}

PreviousAPI Key NextStripe

Last updated 16 days ago

{ "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 }

const response = await fetch('https://app.referralrocket.io/api/v1/addParticipant', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

{ "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" }

const response = await fetch('https://app.referralrocket.io/api/v1/qualifyParticipant', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({}), }); const data = await response.json();

const response = await fetch('https://app.referralrocket.io/api/v1/getReferrals?id=text&email=text&page=%5Bobject+Object%5D', { method: 'GET', headers: {}, }); const data = await response.json();