Programs

APIDescription
GET api/program/getsingle

Get a single program by name.

GET api/Programs

Get a list of referral programs. The offset and count parameters can be used to specify the set of programs. For any given call, the max number of programs returned is 50.

Referrals

APIDescription
GET api/referral/getsingle

Get a single Referral

POST api/referral/update

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.

POST api/referrals/status

Updates the status of a referral.

POST api/referral/remove

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 api/Referrals

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.

POST api/Referrals

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

SalesReceiver

APIDescription
GET api/salesreceiver/config

Gets a list of options used to map the right settings

POST api/salesreceiver/entry

Add a sales entry

Members

APIDescription
POST api/members/update

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.

POST api/members/remove

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 api/Members

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.

POST api/Members

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

Hooks

APIDescription
GET api/Hooks/History/{eventName}

Get a list of history items.

POST api/Hooks

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.

DELETE api/Hooks

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.

Payouts

APIDescription
GET api/payouts/pending

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

GET api/payouts/transactions

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

POST api/payouts/transactions

Payout pending rewards. Returns transactions of issued rewards.

GET api/Payouts/{id}

Get a list of payouts.

Rewards

APIDescription
POST api/rewards/update

Updates rewards from a referral program.

POST api/rewards/issue

Issue a specific reward.

POST api/rewards/remove

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

GET api/Rewards

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

POST api/Rewards

Creates new rewards members and referrals of a referral program.