Programs

APIDescription
GET api/programs

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

GET api/program/getsingle

Get a single program by name.

Members

APIDescription
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.

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.

DELETE 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.

Referrals

APIDescription
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.

GET api/referral/getsingle

Get a single Referral

POST api/referrals

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

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. ("Going to be deprecated" please use POST api/referral/update).

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.

DELETE 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.

Payouts

APIDescription
GET api/payouts/{id}

Get a list of payouts.

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.

Rewards

APIDescription
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.

POST api/rewards/update

Updates rewards from a referral program.

POST api/rewards/issue

Issue a specific reward.

DELETE api/rewards/remove

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

POST api/rewards/remove

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

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

POST api/event

Post Integration Log Event

Hooks

APIDescription
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.

GET api/hooks/history/{eventName}

Get a list of history items.

Email

APIDescription
POST api/email/unsubscribe

Unsubscribe Email Address

POST api/email/removeunsubscribe

Remove Email Address from unsusbscribe list

DELETE api/email/removeunsubscribe

Remove Email Address from unsusbscribe list

GET api/email/getunsubscribed

Get all unsubscribed emails or by email address