Referral Rock

Remove Email Address from unsubscribe list. Same action as referralrock_post_api_email_removeunsubscribe; Referral Rock serves it on both verbs. (DELETE /api/email/removeunsubscribe)

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. (DELETE /api/hooks)

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. Same action as referralrock_post_api_members_remove; Referral Rock serves it on both verbs. (DELETE /api/members/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. Same action as referralrock_post_api_referral_remove; Referral Rock serves it on both verbs. (DELETE /api/referral/remove)

Deletes a reward from a member or referral of a referral program. Same action as referralrock_post_api_rewards_remove; Referral Rock serves it on both verbs. (DELETE /api/rewards/remove)

Get all unsubscribed emails or by email address. (GET /api/email/getunsubscribed)

DEPRECATED - use GET api/v2/hooks/history/{eventName} instead. That version returns each event in the shape our webhooks actually send, and accepts a count parameter. Two differences to expect when you switch: it returns at most 25 items unless you pass a larger count, and it omits any event it cannot render in webhook shape (EmailUnsubscribed is stored as a bare email address, so v2 returns nothing for it). This version returns the raw log shape and applies no record limit, so a busy event can produce a very large response. History is kept for about seven days. (GET /api/hooks/history/{eventName})

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. (GET /api/members)

Get statistics about a member's sharing, referral, and reward activities. (GET /api/memberstats/getsingle)

Get a list of payouts. (GET /api/payouts/{id})

A collection of payouts yet to be transferred to a member. This can be filtered by the member. (GET /api/payouts/pending)

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

Get a single program by name. (GET /api/program/getsingle)

Get a list of referral programs. The offset and count parameters can be used to specify the set of programs. (GET /api/programs)

Get a single Referral. At least one of email, referralId or externalId is required. (GET /api/referral/single)

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/referrals)

Gets a list of member rewards rules. (GET /api/rewardrules)

Gets a list of rewards ordered by create date. The offset and count parameters can be used to specify the set of rewards. (GET /api/rewards)

Get a list of history items with the response matching the output of our webhooks, newest first. History is kept for about seven days, so a request returns up to that much or up to 5000 items, whichever is reached first. (GET /api/v2/hooks/history/{eventName})

Each customer added will update any matching referrals to approved and add them as a pre-loaded member based on your account's settings. Approving a referral triggers any configured rewards; customers with no matching referral are added as pre-loaded members to every program with the Preload New Customers setting on. (POST /api/customerfeed)

Each customer added will update any matching referrals to approved and add them as a pre-loaded member based on your account's settings. Each record is processed independently and the response includes a per-record outcome in the same order as the input. Larger integrations should use the CSV bulk import in the admin UI. (POST /api/customerfeeds)

Remove Email Address from unsubscribe list. (POST /api/email/removeunsubscribe)

Unsubscribe Email Address. (POST /api/email/unsubscribe)

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. (POST /api/hooks)

DEPRECATED: Please use the customer feed endpoint instead: https://api.referralrock.com/Help/Api/POST-api-customerfeed Add a single contact to be used with automatic invites. (POST /api/invitefeed)

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

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, emailAddress or externalId. (POST /api/memberaccessurls)

Creates a new member and adds it to a referral program. (POST /api/members)

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. (POST /api/members/remove)

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/update)

Payout pending rewards. Returns transactions of issued rewards. Pays out real rewards to program participants through the account's configured payout method; a completed payout cannot be reversed here. (POST /api/payouts/transactions)

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. (POST /api/referral/remove)

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/referral/update)

Creates a new Referral Action to be used for processing new recurring rewards. (POST /api/referralaction)

Adds referral to a referral program based on a referral code from a member. (POST /api/referrals)

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

Creates new rewards members and referrals of a referral program. Creates rewards that the program's rules may issue or pay out. (POST /api/rewards)

Issue a specific reward. Issuing a reward can deliver real value to its recipient through the program's configured reward method. (POST /api/rewards/issue)

Deletes a reward from a member or referral of a referral program. (POST /api/rewards/remove)

Updates rewards from a referral program. (POST /api/rewards/update)