Referral Rock Web API

Get a list of referral programs. The offset and count parameters can be used to specify the set of programs.

Get a single program by name.

Creates a new Referral Action to be used for processing new recurring rewards

Get a list of members ordered by create date. The list can be filtered by program. The offset and count parameters can be used to specify the set of members.

Creates a new member and adds it to a referral program.

Updates members of a referral program. For each member, a query object is specified to identify the member to update and a member object is specified to identify the elements to update. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A member will only be updated if it can be uniquely identifier by the query.

Deletes members of a referral program. For each member, a query object is specified to identiy the member to delete. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A member will only be deleted if it can be uniquely identifier by the query.

Deletes members of a referral program. For each member, a query object is specified to identiy the member to delete. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A member will only be deleted if it can be uniquely identifier by the query.

Get statistics about a member's sharing, referral, and reward activities.

Get a list of referrals ordered by create date. The list can be filtered by program. The offset and count parameters can be used to specify the set of referrals.

Get a single Referral. At least one of email, referralId or externalId is required.

Adds referral to a referral program based on a referral code from a member.

Updates referrals in a referral program. For each referral, a query object is specified to identify the referral to update and a referral object is specified to identify the elements to update. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A referral will only be updated if it can be uniquely identifier by the query.

Updates the status of a referral. ("Going to be deprecated" please use POST api/referral/update).

Deletes referrals in a referral program. For each referral, a query object is specified to identiy the referral to delete. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A referral will only be deleted if it can be uniquely identifier by the query.

Deletes referrals in a referral program. For each referral, a query object is specified to identiy the referral to delete. At a minimum, a query object requires either a valid value in primaryInfo or a valid element in both the secondaryInfo and tertiaryInfo elements. A referral will only be deleted if it can be uniquely identifier by the query.

Get a list of payouts.

A collection of payouts yet to be transferred to a member. This can be filtered by the member.

A collection of transactions that represent payouts transferred to participants of a referral program. This can be filtered by recipient or transactionId.

Payout pending rewards. Returns transactions of issued rewards.

Gets a list of rewards ordered by create date. The offset and count parameters can be used to specify the set of referrals.

Creates new rewards members and referrals of a referral program.

Updates rewards from a referral program.

Issue a specific reward.

Deletes a reward from a member or referral of a referral program.

Deletes a reward from a member or referral of a referral program.

Gets a list of member rewards rules.

This endpoint allows a client to specify a url to send data to in the event that an event of interest occurs. When these events occur, the url will receive a POST request with a JSON body of the element in question. These element will match the elements contained in a GET call to the Referral Rock Apis.

This endpoint allows a client to unsubscribe from an event of interest. Afterwards, when the event occurs, the no data will be sent to the previously specified url.

Get a list of history items.

Unsubscribe Email Address

Remove Email Address from unsubscribe list

Remove Email Address from unsubscribe list

Get all unsubscribed emails or by email address

Send a set of contacts to be used with automatic invites.

Add a single contact to be used with automatic invites.

Create a custom member share experience or securely embed the Member Portal or Share Widget in your app. This endpoint returns a Member's unique share links and access links for their portal or share widget. Exactly one search parameter is required: memberId, referralCode, emaillAddress or externalId.

DEPRECATED: Please use the memberaccessurls endpoint instead: https://api.referralrock.com/Help/Api/POST-api-memberaccessurls