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

idstring

The ID of the campaign.

Example: JCu82f30F1

emailstring

The email address of the participant.

Example: [e-mail]

referredByCode[Optional]string

Referral code of the participant referring.

Example: 7ZZp9eBG

referredByEmail[Optional]string

Email of the participant referring.

Example: [e-mail]

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.referralrocket.io/api/v1/addParticipant' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "JCu82f30F1",
    "email": "[e-mail]",
    "referredByCode[Optional]": "7ZZp9eBG",
    "referredByEmail[Optional]": "[e-mail]"
  }'

200

200

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

OK

get

Get campaign program details for the given Id.

Query parameters

idstringrequired

Campaign Id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.referralrocket.io/api/v1/getCampaign?id=text'

200

200

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

OK

get

Get participant details for given campaign Id and email.

Query parameters

emailstringrequired

Email address of the participant

idstringrequired

Campaign Id

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.referralrocket.io/api/v1/getParticipant?email=text&id=text'

200

200

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

OK

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

pageobject

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.referralrocket.io/api/v1/getAllParticipants?id=text'

200

200

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

OK

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

pageobjectrequired

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.referralrocket.io/api/v1/getReferrals?id=text&email=text&page=%5Bobject+Object%5D'

200

200

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

OK

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

idstring

The ID of the campaign.

Example: JCu82f30F1

emailstring

The email address of the participant.

Example: [e-mail]

amountPaid[Optional]string

Amount spent/paid by participant.

Example: 250

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app.referralrocket.io/api/v1/qualifyParticipant' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "JCu82f30F1",
    "email": "[e-mail]",
    "amountPaid[Optional]": "250"
  }'

200

200

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

OK

get

Validate referrer code for a campaign.

Query parameters

campaignIdstringrequired

Campaign Id

codestringrequired

Code

Responses

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app.referralrocket.io/api/v1/validateCode?campaignId=text&code=text'

200

200

true

OK