Skip to main content
ReferralRock logo
  • Category: marketing automation
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 33
  • Triggers: 0
  • Slug: REFERRALROCK
  • Version: 20261101_00

Tools

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

Input Parameters

string
required
The email address to remove from the unsubscribe list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_DELETE_HOOKSTool to delete a webhook subscription. Use when you need to cancel and stop data transmission to a registered webhook URL.

Input Parameters

string
required
The unique ID of the webhook subscription to cancel. Must be a valid GUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_DELETE_MEMBERS_REMOVETool 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.

Input Parameters

array
required
Collection of member removal requests. Each member requires either valid primaryInfo OR both secondaryInfo and tertiaryInfo to be uniquely identified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_DELETE_REFERRAL_REMOVETool 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.

Input Parameters

array
required
List of referral queries to remove. Each must be uniquely identifiable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_DELETE_REWARDS_REMOVETool to delete rewards from members or referrals in a referral program. Use when you need to remove one or more rewards from the system.

Input Parameters

array
required
List of reward identifiers to remove from the system

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_EMAIL_GETUNSUBSCRIBEDTool to check if an email address is unsubscribed from communications. Use when you need to verify unsubscribe status before sending emails.

Input Parameters

string
Email address to check unsubscribe status for. If not provided, retrieves all unsubscribed emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_HOOKS_HISTORY_EVENTNAMERetrieve webhook history for a specific event using the deprecated raw-log history endpoint. History is retained for about seven days and has no record limit, so responses can be large.

Input Parameters

string
required
The name of the event to retrieve webhook history for (e.g., ‘MemberAdd’, ‘MemberUpdate’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_MEMBERSTool 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.

Input Parameters

string ("Create_Dt_Asc" | "Create_Dt_Desc" | "Member_Views_Asc" | "Member_Views_Desc" | "Page_Views_Asc" | "Page_Views_Desc" | "Lead_Count_Asc" | "Lead_Count_Desc" | "Reward_Issued_Total_Asc" | "Reward_Issued_Total_Desc" | "Member_Full_Name_Asc" | "Member_Full_Name_Desc")
Sorting column. Default is Create_Dt_Desc (newest first).
integer
Number of members to return. Default returns all available members.
string
Search query - member must have this value as email, internal ID, external ID, or referral code.
string
Filter members created on or before this date (ISO 8601 format: YYYY-MM-DD).
integer
Starting index (0-based) for pagination. Default is 0.
string
Filter members created on or after this date (ISO 8601 format: YYYY-MM-DD).
string
Program identifier using ID, name, or title to filter members by program.
boolean
True displays disabled members; False shows active members only. If not specified, returns both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_MEMBER_STATS_GET_SINGLETool 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.

Input Parameters

string
required
Identifier for the member. Can be an email address, member ID, external ID, or referral code.
string ("All" | "MonthToDate" | "LastMonth" | "Last7Days" | "Last30Days")
required
The time range for which to retrieve statistics. Accepted values are: All (all-time statistics), MonthToDate (statistics from the beginning of the current month), LastMonth (statistics from the previous month), Last7Days (statistics from the last 7 days), Last30Days (statistics from the last 30 days).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_PAYOUTS_IDRetrieve a list of payouts using the supplied ID.

Input Parameters

string
required
The unique identifier for the payout to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_PAYOUTS_PENDINGTool 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.

Input Parameters

string
The unique ID of the member to whom the amount is owed (deprecated, use recipientId instead).
string
Unique identifier of the recipient owed the amount.
boolean
Includes payouts for ineligible rewards with future eligibility dates. Defaults to False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_PAYOUTS_TRANSACTIONSTool 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.

Input Parameters

string
The unique ID of the payout transaction recipient.
string
The unique ID of the payout transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_PROGRAM_GETSINGLETool to retrieve a single referral program by name. Use when you need details about a specific program.

Input Parameters

string
required
Name of the program of interest

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_PROGRAMSList all referral programs in ReferralRock. Use this to retrieve details about available referral programs with pagination support.

Input Parameters

integer
Number of programs to return. Default is 30. Maximum depends on API limits.
integer
Starting index (0 based) of the programs to retrieve. Used for pagination.
string
Identifies a specific program of interest. Use this to filter for a particular program.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_REFERRALSTool 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.

Input Parameters

string ("Create_Dt_Desc" | "Create_Dt_Asc" | "Amount_Desc" | "Amount_Asc" | "Qualified_Dt_Desc" | "Qualified_Dt_Asc" | "Closed_Dt_Desc" | "Closed_Dt_Asc")
Sort order for the results. Default is Create_Dt_Desc (newest first).
integer
Number of referrals to return per page. Default is all available referrals.
string
Search term to filter referrals by email, internal ID, external ID, or referral code. If matches internal referral ID, overrides other filters.
string
Show referrals created on or before this date. Format: ISO8601 date string (e.g., ‘2023-12-31’).
integer
Starting index for pagination (0-based). Default is 0.
string ("pending" | "qualified" | "approved" | "denied")
Filter referrals by their current status.
string
Show referrals created on or after this date. Format: ISO8601 date string (e.g., ‘2023-01-01’).
string
Filter results to show referrals associated with a specific member.
string
Program identifier (ID, name, or title) to filter referrals by specific program.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_REFERRAL_SINGLETool 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.

Input Parameters

string
The email address of the referral to retrieve.
string
The external identifier of the referral to retrieve.
string
The unique identifier of the referral to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_REWARDRULESTool 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.

Input Parameters

string
required
ID of the program. This is a required parameter that identifies which program’s reward rules to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_GET_REWARDSTool 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.

Input Parameters

string
Sort column. Defaults to Create_Dt_Desc if not specified.
integer
Number of reward records to return. Defaults to all records if not specified.
string
Filter by recipient email, ID, external ID, or member referral code.
string
Show rewards created before this date (ISO format or date string).
integer
Starting index for pagination (0-based). Defaults to 0.
string
Filter by reward status. Valid values: Pending, Processing, Issued.
string
Show rewards created after this date (ISO format or date string).
string
GUID identifier of the member to filter by.
string
ID of the program, program name, or program title to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_EMAIL_REMOVEUNSUBSCRIBETool 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.

Input Parameters

string
required
The email address to be removed from the unsubscribe list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_EMAIL_UNSUBSCRIBETool to unsubscribe an email address from the ReferralRock mailing list. Use when a user wants to opt out of email communications.

Input Parameters

string
required
Email address to unsubscribe from the mailing list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_HOOKSTool 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.

Input Parameters

string ("ProgramAdd" | "MemberAdd" | "MemberUpdate" | "MemberDelete" | "ReferralAdd" | "ReferralStatusChange" | "ReferralUpdate" | "ReferralDelete" | "RewardAdd" | "RewardIssue" | "EmailUnsubscribed")
required
Event type to monitor. Valid values: ProgramAdd, MemberAdd, MemberUpdate, MemberDelete, ReferralAdd, ReferralStatusChange, ReferralUpdate, ReferralDelete, RewardAdd, RewardIssue, or EmailUnsubscribed.
string
required
The callback URL that receives event notifications via POST requests with JSON data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_INVITEFEEDAdd a single contact for automatic invitations using the deprecated invite feed endpoint.

Input Parameters

string
required
Contact’s email address.
string
required
Contact’s last name.
string
required
Contact’s first name.
string
Optional contact type identifier to declare the API event where the contact originates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_INVITEFEEDSTool 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.

Input Parameters

array
required
Array of invite feed entries to create. Each entry must include firstName, lastName, and email (all required), with an optional contactType parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_MEMBER_ACCESS_URLSGenerate a member’s unique share and access links for a custom share experience or secure portal embedding, with optional expiration. Exactly one member identifier is required.

Input Parameters

string
Internal member ID (36 characters). One of four identifiers required.
string
External system ID (0-100 characters). One of four identifiers required.
string
Member’s email address (0-100 characters). One of four identifiers required.
string
Member’s referral code (0-50 characters). One of four identifiers required.
integer
Link expiration time in minutes (5-43200). Defaults to 20 minutes if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_MEMBERSCreate a new member and add them to a referral program using their program ID, name, and email.

Input Parameters

string
City name.
string
required
Member’s email address.
string
Contact phone number.
string
Country name.
string
Member’s surname.
string
Member account password. If not provided, member will need to reset password on first login.
string
required
Member’s first name.
string
required
Program identifier for membership. This is the GUID of the program to which the member will be added.
object
Payment configuration object for member rewards.
string
Postal or ZIP code.
string
Birth date in ISO format (YYYY-MM-DD).
string
Primary address line.
string
Secondary address line (apartment, suite, etc.).
boolean
Membership activation status. Set to true to create the member in a disabled state.
string
Custom referral identifier. If not provided, one will be auto-generated.
string
Custom text field name for additional member data.
string
Second custom text field name for additional member data.
boolean
Triggers confirmation email; defaults to false. Set to true to send a welcome email to the new member.
string
Custom text field value for customText1Name.
string
Second custom text field value for customText2Name.
string
Custom field name for additional member data.
string
Branded URL override for the member’s referral links.
string
Associated recruiter ID (GUID). Either this or recruiterAssignedId is conditionally required if the program requires a recruiter.
string
State or province designation.
string
Custom field value for customOption1Name.
string
External system link identifier for integration purposes.
string
Currently assigned recruiter ID (GUID). Either this or recruiterSourceId is conditionally required if the program requires a recruiter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_MEMBERS_REMOVETool 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.

Input Parameters

array
required
Array of member removal information objects. Each object contains a query to identify the member to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REFERRALACTIONTool 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.

Input Parameters

string
Identifier for the referral action. Optional name to describe the action.
number
required
Referral action amount, used for calculating percentage based recurring rewards
string
Search by program ID, name, or title. Optional parameter to specify the program.
string
required
Lookup mechanism using ReferralID, email, or External ID
string
External ID, used for preventing duplicates and referencing original source. Optional unique identifier from external system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REFERRAL_REMOVERemove referrals from a referral program using referral IDs or alternative identifiers. Each query must contain a valid primary identifier or valid secondary and tertiary identifiers, and a referral is deleted only if uniquely identified.

Input Parameters

array
required
Collection of referral identification queries. Each referral requires either primaryInfo OR both secondaryInfo and tertiaryInfo for unique identification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REFERRALSTool 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.

Input Parameters

string
City name.
string
Internal notes about the referral. Not visible to the referral.
string
Referral’s email address.
string
Order total or transaction value.
string
State/province/region.
string ("pending" | "qualified" | "approved" | "denied")
Referral state. Allowed values: ‘pending’, ‘qualified’, ‘approved’, or ‘denied’.
string
Country name.
string
Referral’s surname.
string
Referral’s given name.
string
ZIP/postal code.
string
Publicly visible referral notes.
string
Business name.
string
Customer contact number.
string
Street address line 1.
string
Street address line 2 (apartment, suite, etc.).
string
required
The referral code from the member that introduced the referral. This is required to associate the referral with a specific member.
string
Custom text 1 field name.
string
Custom text 2 field name.
string
Custom text 3 field name.
string
Custom text 1 field value.
string
Custom text 2 field value.
string
Custom text 3 field value.
string ("email" | "callMorning" | "callAfternoon" | "callEvening")
Contact preference. Allowed values: ‘email’, ‘callMorning’, ‘callAfternoon’, or ‘callEvening’.
string
Custom option 1 field name.
string
Custom option 2 field name.
string
Custom option 1 field value.
string
Custom option 2 field value.
string
Unique external identifier you can use to later reference the referral.
string
Currently assigned recruiter identifier (GUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REFERRALS_STATUSTool 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.

Input Parameters

string
Referral reward amount as a decimal value
string
required
New status value for the referral. Must be one of: ‘pending’, ‘qualified’, ‘approved’, or ‘denied’
string
Identifier of the associated program
string
Customer-facing note about the status update
string
required
Identifier for the referral to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REFERRAL_UPDATETool 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.

Input Parameters

array
required
List of referral updates to process. Each item contains a query to identify the referral and the fields to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REWARDS_ISSUETool 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.

Input Parameters

string
A message sent to the reward recipient.
string
required
The unique identifier for the reward being issued.
string
For PayPal, include the email address of the recipient. (Deprecated parameter)
boolean
Allows you to override eligibility date rules. Issue rewards with eligibility dates in the future.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: REFERRALROCK_POST_REWARDS_REMOVETool 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.

Input Parameters

array
required
List of reward identifiers to be removed. Each ID should be a string representing a reward in the referral program.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not