Recurring Rewards using our API (Internal)

Recurring Rewards Using the API 

Recurring rewards must be created completely using Referral Rock's API from scratch. While this takes a bit of custom development, Referral Rock is often still highly valuable for the attribution, management, payouts, communication, and analysis associated with the program. In general, there are two ways to set up recurring rewards:

  1. Store associates members with referrals to reference in the future.

When a referral is created, store the associated member RRid, member email, or member externalid somewhere with that referral so that it can be used to create member rewards multiple times in the future.

Whenever a purchase is made, if there is an associated member, create a new Referral Rock reward via the API. In this case, you would use the POST API/rewards. This call takes a member query, using the stored parameter and then passes the reward via the NewReward structure.

The NewReward structure will allow you to automatically link the reward to an existing payout in Referral Rock, using the payoutId. In addition, you can set an eligibility date if you want to delay payout.

We would generally recommend going with this option, as it reduces the number of API calls necessary, as API calls are sent only for those customers with associated members. 

  1. Check all purchases/conversions for an associated member via RR

Alternatively, if it is not easy for you to create a new database field for storing the associated member, you will need to check all conversions against Referral Rock and create rewards for associated members. 

First, use the Get API/referrals/getsingle call to check if the referral exists and get information on the referring member if so. In this scenario, you would use a query like the referral email address, referral id, or external id.

If the referral does exist, get the ReferringMemberId or memberEmail from the response and use this to create a new member reward. Use the POST API/rewards, using the id or email from above to query the member and then the NewReward structure to set up the reward.

The NewReward structure will allow you to automatically link the reward to an existing payout in Referral Rock, using the payoutId. In addition, you can set an eligibility date if you want to delay payout


How did we do?


Powered by HelpDocs

Powered by HelpDocs