# ReferralRock

ReferralRock is a referral marketing platform that helps businesses create and manage referral programs to drive word-of-mouth growth and customer acquisition

- **Category:** marketing automation
- **Auth:** BASIC
- **Tools:** 35
- **Triggers:** 0
- **Slug:** `REFERRALROCK`
- **Version:** 00000000_00

## Tools

### Remove Email from Unsubscribe List

**Slug:** `REFERRALROCK_DELETE_EMAIL_REMOVEUNSUBSCRIBE`

Tool to remove an email address from the unsubscribe list. Use when you need to resubscribe an email address that was previously unsubscribed.

### Delete Webhook

**Slug:** `REFERRALROCK_DELETE_HOOKS`

Tool to delete a webhook subscription. Use when you need to cancel and stop data transmission to a registered webhook URL.

### Delete Members from Program

**Slug:** `REFERRALROCK_DELETE_MEMBERS_REMOVE`

Tool to delete members from a referral program. Use when you need to remove one or more members. Each member requires either valid primaryInfo (memberId or referralCode) OR both secondaryInfo (externalIdentifier or email) and tertiaryInfo (program details) to be uniquely identified.

### Delete Referral

**Slug:** `REFERRALROCK_DELETE_REFERRAL_REMOVE`

Tool to delete one or more referrals from a referral program. Use when you need to remove referrals by their unique ID or other identifying information. Each referral is deleted only when it can be uniquely identified.

### Delete Rewards

**Slug:** `REFERRALROCK_DELETE_REWARDS_REMOVE`

Tool to delete rewards from members or referrals in a referral program. Use when you need to remove one or more rewards from the system.

### Get Email Unsubscribed Status

**Slug:** `REFERRALROCK_GET_EMAIL_GETUNSUBSCRIBED`

Tool to check if an email address is unsubscribed from communications. Use when you need to verify unsubscribe status before sending emails.

### Get Webhook History for Event

**Slug:** `REFERRALROCK_GET_HOOKS_HISTORY_EVENTNAME`

Tool to retrieve webhook history for a specific event. Use when you need to check the delivery status and details of webhooks for a particular event type.

### List Program Members

**Slug:** `REFERRALROCK_GET_MEMBERS`

Tool to list program members with filtering and pagination. Use when you need to retrieve member information, optionally filtering by program, search query, status, or date range. Supports sorting and pagination for large datasets.

### Get Member Statistics

**Slug:** `REFERRALROCK_GET_MEMBER_STATS_GET_SINGLE`

Tool to retrieve comprehensive statistics for a single member from ReferralRock. Use when you need to analyze a member's sharing, referral, and reward activities over a specified time period.

### Get Payout

**Slug:** `REFERRALROCK_GET_PAYOUT`

Tool to retrieve payout list by ID. Use when you need to get specific payout information using a payout identifier.

### Get Payout Details by ID

**Slug:** `REFERRALROCK_GET_PAYOUTS_ID`

Tool to get payout details by ID. Use when you need to retrieve specific payout information using a payout identifier.

### Get Pending Payouts

**Slug:** `REFERRALROCK_GET_PAYOUTS_PENDING`

Tool to get pending payouts for a member or recipient. Use when you need to retrieve pending payout information, optionally filtering by recipient and including ineligible rewards.

### Get Payout Transactions

**Slug:** `REFERRALROCK_GET_PAYOUTS_TRANSACTIONS`

Tool to get payout transaction history for referral program participants. Use when you need to retrieve payout transaction information, optionally filtering by recipient ID or specific transaction ID.

### Get Single Program

**Slug:** `REFERRALROCK_GET_PROGRAM_GETSINGLE`

Tool to retrieve a single referral program by name. Use when you need details about a specific program.

### List Referral Programs

**Slug:** `REFERRALROCK_GET_PROGRAMS`

List all referral programs in ReferralRock. Use this to retrieve details about available referral programs with pagination support.

### Get Referrals

**Slug:** `REFERRALROCK_GET_REFERRALS`

Tool to list referrals with filtering and pagination options. Use when you need to retrieve referrals from ReferralRock, optionally filtered by program, member, date range, status, or search query. Supports sorting and pagination.

### Get Single Referral

**Slug:** `REFERRALROCK_GET_REFERRAL_SINGLE`

Tool to retrieve a single referral by email, ID, or external ID. Use when you need to fetch detailed information about a specific referral from ReferralRock.

### Get Reward Rules

**Slug:** `REFERRALROCK_GET_REWARDRULES`

Tool to get reward rules for a program. Use when you need to retrieve member rewards rules configuration including triggers, payouts, and delivery settings for a specific program.

### Get Rewards

**Slug:** `REFERRALROCK_GET_REWARDS`

Tool to list rewards with optional filtering and pagination. Use when you need to retrieve rewards filtered by program, member, status, date ranges, or specific search queries. Supports sorting and pagination via offset/count parameters.

### Remove Email from Unsubscribe List

**Slug:** `REFERRALROCK_POST_EMAIL_REMOVEUNSUBSCRIBE`

Tool to remove an email address from the unsubscribe list. Use when you need to resubscribe a previously unsubscribed email address to allow them to receive emails again.

### Unsubscribe Email Address

**Slug:** `REFERRALROCK_POST_EMAIL_UNSUBSCRIBE`

Tool to unsubscribe an email address from the ReferralRock mailing list. Use when a user wants to opt out of email communications.

### Create Webhook Subscription

**Slug:** `REFERRALROCK_POST_HOOKS`

Tool to create or update a webhook subscription for event notifications. Use when you need to register a callback URL to receive POST requests with JSON data when specified events occur.

### Create Invite Feed Entry

**Slug:** `REFERRALROCK_POST_INVITEFEED`

Tool to create an invite feed entry for automatic invitations. Use when you need to add a contact to the referral program's invite queue.

### Create Invite Feed Entries

**Slug:** `REFERRALROCK_POST_INVITEFEEDS`

Tool to create multiple invite feed entries for automatic invites in ReferralRock. Use when you need to send a set of contacts to be used with automatic member invitations.

### Generate Member Access Token

**Slug:** `REFERRALROCK_POST_MEMBERACCESS`

Tool to generate pre-authenticated member access URLs for sharing and portal experiences. Use when you need to create temporary access tokens for members to access their portal or share content. Note: This endpoint is deprecated; consider using memberaccessurls endpoint instead.

### Generate Member Access URLs

**Slug:** `REFERRALROCK_POST_MEMBER_ACCESS_URLS`

Tool to generate member access URLs for custom share experience or secure portal embedding. Use when you need to create unique access and share links for members with optional expiration time.

### Add new member to program

**Slug:** `REFERRALROCK_POST_MEMBERS`

Tool to create a new member and add them to a referral program. Use when you need to add a new member with their program ID, name, and email. Returns HTTP 201 (Created) on success with member confirmation details.

### Remove Members from Program

**Slug:** `REFERRALROCK_POST_MEMBERS_REMOVE`

Tool to remove members from a referral program. Use when you need to delete members from the system. A member is removed when uniquely identified by either primaryInfo (memberId or referralCode) OR both secondaryInfo and tertiaryInfo.

### Create Referral Action

**Slug:** `REFERRALROCK_POST_REFERRALACTION`

Tool to create a referral action for processing recurring rewards. Use when you need to record a referral action with an amount value for calculating percentage-based recurring rewards. The action can be linked to referrals via email, ID, or external identifier.

### Remove Referral

**Slug:** `REFERRALROCK_POST_REFERRAL_REMOVE`

Tool to remove referrals from a referral program. Use when you need to delete referrals using their referral ID or alternative identifiers.

### Create New Referral

**Slug:** `REFERRALROCK_POST_REFERRALS`

Tool to create a new referral in ReferralRock based on a member's referral code. Use when you need to add a referral to a program, providing details like contact information, transaction amount, and custom fields.

### Update Referral Status

**Slug:** `REFERRALROCK_POST_REFERRALS_STATUS`

Tool to update referral status in ReferralRock. Use when you need to change a referral's status to pending, qualified, approved, or denied. Note: This endpoint is deprecated; use POST /api/referral/update instead.

### Update Referral Details

**Slug:** `REFERRALROCK_POST_REFERRAL_UPDATE`

Tool to update referral details in a referral program. Use when you need to modify existing referral information such as contact details, status, notes, or custom fields. Requires either a referralId OR both secondaryInfo and tertiaryInfo to identify referrals. Supports bulk updates by providing multiple update items.

### Issue Reward to Member

**Slug:** `REFERRALROCK_POST_REWARDS_ISSUE`

Tool to issue a reward to a member in the Referral Rock system. Use when you need to issue a specific reward to a recipient, with the option to override eligibility date rules.

### Remove Rewards

**Slug:** `REFERRALROCK_POST_REWARDS_REMOVE`

Tool to remove rewards from members or referrals of a referral program. Use when you need to delete one or more rewards by their IDs. The endpoint returns a result for each reward ID indicating whether the removal was successful.
