API Endpoint

post

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.

Body

application/json

idstringRequired

The ID of the campaign.

Example: JCu82f30F1

emailstringRequired

The email address of the participant.

Example: [e-mail]

referredByCodestringOptional

Referral code of the participant referring.

Example: 7ZZp9eBG

referredByEmailstringOptional

Email of the participant referring.

Example: [e-mail]

Responses

200

OK

application/json

emailstringOptional

The email address of the participant.

Example: [e-mail]

firstNamestringOptional

The first name of the participant.

Example: john

lastNamestringOptional

The last name of the participant.

Example: doe

referralCodestringOptional

The unique referral code of the participant.

Example: 8Mnu09TD

referredByCodestringOptional

The referral code of the invitee.

Example: 7ZZp9eBG

createdOnstring · date-timeOptional

The datetime when participant joined the program.

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

campaignIdstringOptional

The campaign Id of the program participant is part of.

Example: JCu82f30F1

shareLinkstringOptional

The unique referral link of the participant.

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

totalReferralsintegerOptional

The total referrals made by the participant.

Example: 0

referralRewardintegerOptional

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedintegerOptional

The total referral reward redeemed.

Example: 0

referralRewardBalanceintegerOptional

The total referral balance left.

Example: 0

refereeRewardintegerOptional

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedintegerOptional

The total referee reward redeemed.

Example: 0

refereeRewardBalanceintegerOptional

The total referee balance left.

Example: 0

rewardEventCompletedbooleanOptional

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

Example: false

fraudScorestringOptional

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

Example: Low

404

Not Found

application/json

500

Internal Server Error

application/json

post

/api/v1/addParticipant

HTTPcURLJavaScriptPython

POST /api/v1/addParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "id": "JCu82f30F1",
  "email": "[e-mail]",
  "referredByCode": "7ZZp9eBG",
  "referredByEmail": "[e-mail]"
}

{
  "email": "[e-mail]",
  "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

Get campaign program details for the given Id.

Query parameters

idstringRequired

Campaign Id

Responses

200

OK

application/json

campaignIdstringOptional

The ID of the campaign.

Example: JCu82f30F1

campaignNamestringOptional

The name of the campaign.

Example: Q4 Growth Program

statusstring · enumOptional

Campaign status. [Active, Pause, End].

Example: ActivePossible values:

createdOnstring · date-timeOptional

Campaign creation date.

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

endstring · date-timeOptional

Campaign end date if set.

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

hostURLstringOptional

Campaign URL.

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

pausedbooleanOptional

The flag indicates if the campaign is paused or not.

Example: false

endedbooleanOptional

The flag indicates if the campaign has ended or not.

Example: false

rewardHeaderstringOptional

Campaign reward header.

Example: Refer a friend and win

rewardDescriptionstringOptional

Campaign reward description.

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

shareHeaderstringOptional

Campaign share widget header.

Example: Refer a friend and win

shareDescriptionstringOptional

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.

referrerRewardValueintegerOptional

Referrer reward value.

Example: 20

refereeRewardValueintegerOptional

Referee reward value.

Example: 20

rewardTypestringOptional

Reward type.

Example: Monetary

participantsintegerOptional

Total participant in the campaign.

Example: 8

404

Not Found

application/json

get

/api/v1/getCampaign

HTTPcURLJavaScriptPython

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
}

get

Validate referrer code for a campaign.

Query parameters

campaignIdstringRequired

Campaign Id

codestringRequired

Code

Responses

200

OK

application/json

booleanOptional

get

/api/v1/validateCode

HTTPcURLJavaScriptPython

GET /api/v1/validateCode?campaignId=text&code=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*

200

OK

true

get

Get participant details for given campaign Id and email.

Query parameters

emailstringRequired

Email address of the participant

idstringRequired

Campaign Id

Responses

200

OK

application/json

emailstringOptional

The email address of the participant.

Example: [e-mail]

firstNamestringOptional

The first name of the participant.

Example: john

lastNamestringOptional

The last name of the participant.

Example: doe

referralCodestringOptional

The unique referral code of the participant.

Example: 8Mnu09TD

referredByCodestringOptional

The referral code of the invitee.

Example: 7ZZp9eBG

createdOnstring · date-timeOptional

The datetime when participant joined the program.

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

campaignIdstringOptional

The campaign Id of the program participant is part of.

Example: JCu82f30F1

shareLinkstringOptional

The unique referral link of the participant.

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

totalReferralsintegerOptional

The total referrals made by the participant.

Example: 0

referralRewardintegerOptional

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedintegerOptional

The total referral reward redeemed.

Example: 0

referralRewardBalanceintegerOptional

The total referral balance left.

Example: 0

refereeRewardintegerOptional

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedintegerOptional

The total referee reward redeemed.

Example: 0

refereeRewardBalanceintegerOptional

The total referee balance left.

Example: 0

rewardEventCompletedbooleanOptional

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

Example: false

fraudScorestringOptional

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

Example: Low

get

/api/v1/getParticipant

HTTPcURLJavaScriptPython

GET /api/v1/getParticipant?email=text&id=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*

200

OK

{
  "email": "[e-mail]",
  "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

Get all participants of a campaign. API returns 20 records at a time. You can adjust the size by passing in the Pageable params.

Query parameters

idstringRequired

Campaign Id

Responses

200

OK

application/json

emailstringOptional

The email address of the participant.

Example: [e-mail]

firstNamestringOptional

The first name of the participant.

Example: john

lastNamestringOptional

The last name of the participant.

Example: doe

referralCodestringOptional

The unique referral code of the participant.

Example: 8Mnu09TD

referredByCodestringOptional

The referral code of the invitee.

Example: 7ZZp9eBG

createdOnstring · date-timeOptional

The datetime when participant joined the program.

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

campaignIdstringOptional

The campaign Id of the program participant is part of.

Example: JCu82f30F1

shareLinkstringOptional

The unique referral link of the participant.

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

totalReferralsintegerOptional

The total referrals made by the participant.

Example: 0

referralRewardintegerOptional

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedintegerOptional

The total referral reward redeemed.

Example: 0

referralRewardBalanceintegerOptional

The total referral balance left.

Example: 0

refereeRewardintegerOptional

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedintegerOptional

The total referee reward redeemed.

Example: 0

refereeRewardBalanceintegerOptional

The total referee balance left.

Example: 0

rewardEventCompletedbooleanOptional

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

Example: false

fraudScorestringOptional

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

Example: Low

get

/api/v1/getAllParticipants

HTTPcURLJavaScriptPython

GET /api/v1/getAllParticipants?id=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*

200

OK

[
  {
    "email": "[e-mail]",
    "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

Return all referrals of a participant. The API returns 20 records at a time. You can adjust the size by passing the Pageable params.

Query parameters

idstringRequired

Campaign Id

emailstringRequired

Email address of the participant

Responses

200

OK

application/json

emailstringOptional

The email address of the participant.

Example: [e-mail]

firstNamestringOptional

The first name of the participant.

Example: john

lastNamestringOptional

The last name of the participant.

Example: doe

referralCodestringOptional

The unique referral code of the participant.

Example: 8Mnu09TD

referredByCodestringOptional

The referral code of the invitee.

Example: 7ZZp9eBG

createdOnstring · date-timeOptional

The datetime when participant joined the program.

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

campaignIdstringOptional

The campaign Id of the program participant is part of.

Example: JCu82f30F1

shareLinkstringOptional

The unique referral link of the participant.

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

totalReferralsintegerOptional

The total referrals made by the participant.

Example: 0

referralRewardintegerOptional

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedintegerOptional

The total referral reward redeemed.

Example: 0

referralRewardBalanceintegerOptional

The total referral balance left.

Example: 0

refereeRewardintegerOptional

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedintegerOptional

The total referee reward redeemed.

Example: 0

refereeRewardBalanceintegerOptional

The total referee balance left.

Example: 0

rewardEventCompletedbooleanOptional

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

Example: false

fraudScorestringOptional

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

Example: Low

get

/api/v1/getReferrals

HTTPcURLJavaScriptPython

GET /api/v1/getReferrals?id=text&email=text HTTP/1.1
Host: app.referralrocket.io
Accept: */*

200

OK

[
  {
    "email": "[e-mail]",
    "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"
  }
]

post

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.

Body

application/json

idstringRequired

The ID of the campaign.

Example: JCu82f30F1

emailstringRequired

The email address of the participant.

Example: [e-mail]

amountPaidstringOptional

Amount spent/paid by participant.

Example: 250

Responses

200

OK

application/json

emailstringOptional

The email address of the participant.

Example: [e-mail]

firstNamestringOptional

The first name of the participant.

Example: john

lastNamestringOptional

The last name of the participant.

Example: doe

referralCodestringOptional

The unique referral code of the participant.

Example: 8Mnu09TD

referredByCodestringOptional

The referral code of the invitee.

Example: 7ZZp9eBG

createdOnstring · date-timeOptional

The datetime when participant joined the program.

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

campaignIdstringOptional

The campaign Id of the program participant is part of.

Example: JCu82f30F1

shareLinkstringOptional

The unique referral link of the participant.

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

totalReferralsintegerOptional

The total referrals made by the participant.

Example: 0

referralRewardintegerOptional

The total rewards earned by referrals.

Example: 0

referralRewardRedeemedintegerOptional

The total referral reward redeemed.

Example: 0

referralRewardBalanceintegerOptional

The total referral balance left.

Example: 0

refereeRewardintegerOptional

The total rewards earned by joining the program.

Example: 20

refereeRewardRedeemedintegerOptional

The total referee reward redeemed.

Example: 0

refereeRewardBalanceintegerOptional

The total referee balance left.

Example: 0

rewardEventCompletedbooleanOptional

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

Example: false

fraudScorestringOptional

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

Example: Low

post

/api/v1/qualifyParticipant

HTTPcURLJavaScriptPython

POST /api/v1/qualifyParticipant HTTP/1.1
Host: app.referralrocket.io
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "id": "JCu82f30F1",
  "email": "[e-mail]",
  "amountPaid": "250"
}

200

OK

{
  "email": "[e-mail]",
  "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"
}