NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

ReferralRock

referralrock

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

Marketing AutomationWeb del proveedor
Acciones
35
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (35)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Remove Email from Unsubscribe ListREFERRALROCK_DELETE_EMAIL_REMOVEUNSUBSCRIBEAcción

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

Parámetros de entrada

  • emailstringObligatorio

    The email address to remove from the unsubscribe list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete WebhookREFERRALROCK_DELETE_HOOKSAcción

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

Parámetros de entrada

  • web_hook_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Members from ProgramREFERRALROCK_DELETE_MEMBERS_REMOVEAcción

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.

Parámetros de entrada

  • membersobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ReferralREFERRALROCK_DELETE_REFERRAL_REMOVEAcción

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.

Parámetros de entrada

  • referralsobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete RewardsREFERRALROCK_DELETE_REWARDS_REMOVEAcción

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.

Parámetros de entrada

  • reward_idsstring[]Obligatorio

    List of reward identifiers to remove from the system

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Email Unsubscribed StatusREFERRALROCK_GET_EMAIL_GETUNSUBSCRIBEDAcción

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

Parámetros de entrada

  • emailstring

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Webhook History for EventREFERRALROCK_GET_HOOKS_HISTORY_EVENTNAMEAcción

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.

Parámetros de entrada

  • event_namestringObligatorio

    The name of the event to retrieve webhook history for (e.g., 'MemberAdd', 'MemberUpdate').

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Program MembersREFERRALROCK_GET_MEMBERSAcción

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.

Parámetros de entrada

  • sortstringenum

    Sorting column. Default is Create_Dt_Desc (newest first).

    Create_Dt_AscCreate_Dt_DescMember_Views_AscMember_Views_DescPage_Views_AscPage_Views_DescLead_Count_AscLead_Count_DescReward_Issued_Total_AscReward_Issued_Total_DescMember_Full_Name_AscMember_Full_Name_Desc
  • countinteger

    Number of members to return. Default returns all available members.

  • querystring

    Search query - member must have this value as email, internal ID, external ID, or referral code.

  • dateTostring

    Filter members created on or before this date (ISO 8601 format: YYYY-MM-DD).

  • offsetinteger

    Starting index (0-based) for pagination. Default is 0.

  • dateFromstring

    Filter members created on or after this date (ISO 8601 format: YYYY-MM-DD).

  • programIdstring

    Program identifier using ID, name, or title to filter members by program.

  • showDisabledboolean

    True displays disabled members; False shows active members only. If not specified, returns both.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Member StatisticsREFERRALROCK_GET_MEMBER_STATS_GET_SINGLEAcción

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.

Parámetros de entrada

  • querystringObligatorio

    Identifier for the member. Can be an email address, member ID, external ID, or referral code.

  • timePeriodstringObligatorioenum

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

    AllMonthToDateLastMonthLast7DaysLast30Days

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PayoutREFERRALROCK_GET_PAYOUTAcción

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

Parámetros de entrada

  • idstringObligatorio

    The unique identifier for the payout to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Payout Details by IDREFERRALROCK_GET_PAYOUTS_IDAcción

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

Parámetros de entrada

  • idstringObligatorio

    The unique identifier for the payout to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Pending PayoutsREFERRALROCK_GET_PAYOUTS_PENDINGAcción

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.

Parámetros de entrada

  • memberIdstring

    The unique ID of the member to whom the amount is owed (deprecated, use recipientId instead).

  • recipientIdstring

    Unique identifier of the recipient owed the amount.

  • includeIneligibleboolean

    Includes payouts for ineligible rewards with future eligibility dates. Defaults to False.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Payout TransactionsREFERRALROCK_GET_PAYOUTS_TRANSACTIONSAcción

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.

Parámetros de entrada

  • recipientIdstring

    The unique ID of the payout transaction recipient.

  • transactionIdstring

    The unique ID of the payout transaction.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Single ProgramREFERRALROCK_GET_PROGRAM_GETSINGLEAcción

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

Parámetros de entrada

  • programNamestringObligatorio

    Name of the program of interest

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Referral ProgramsREFERRALROCK_GET_PROGRAMSAcción

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

Parámetros de entrada

  • countinteger

    Number of programs to return. Default is 30. Maximum depends on API limits.

  • offsetinteger

    Starting index (0 based) of the programs to retrieve. Used for pagination.

  • programIdstring

    Identifies a specific program of interest. Use this to filter for a particular program.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get ReferralsREFERRALROCK_GET_REFERRALSAcción

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.

Parámetros de entrada

  • sortstringenum

    Sort order for the results. Default is Create_Dt_Desc (newest first).

    Create_Dt_DescCreate_Dt_AscAmount_DescAmount_AscQualified_Dt_DescQualified_Dt_AscClosed_Dt_DescClosed_Dt_Asc
  • countinteger

    Number of referrals to return per page. Default is all available referrals.

  • querystring

    Search term to filter referrals by email, internal ID, external ID, or referral code. If matches internal referral ID, overrides other filters.

  • dateTostring

    Show referrals created on or before this date. Format: ISO8601 date string (e.g., '2023-12-31').

  • offsetinteger

    Starting index for pagination (0-based). Default is 0.

  • statusstringenum

    Filter referrals by their current status.

    pendingqualifiedapproveddenied
  • dateFromstring

    Show referrals created on or after this date. Format: ISO8601 date string (e.g., '2023-01-01').

  • memberIdstring

    Filter results to show referrals associated with a specific member.

  • programIdstring

    Program identifier (ID, name, or title) to filter referrals by specific program.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Single ReferralREFERRALROCK_GET_REFERRAL_SINGLEAcción

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.

Parámetros de entrada

  • emailstring

    The email address of the referral to retrieve.

  • externalIdstring

    The external identifier of the referral to retrieve.

  • referralIdstring

    The unique identifier of the referral to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Reward RulesREFERRALROCK_GET_REWARDRULESAcción

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.

Parámetros de entrada

  • programIdstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get RewardsREFERRALROCK_GET_REWARDSAcción

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.

Parámetros de entrada

  • sortstring

    Sort column. Defaults to Create_Dt_Desc if not specified.

  • countinteger

    Number of reward records to return. Defaults to all records if not specified.

  • querystring

    Filter by recipient email, ID, external ID, or member referral code.

  • dateTostring

    Show rewards created before this date (ISO format or date string).

  • offsetinteger

    Starting index for pagination (0-based). Defaults to 0.

  • statusstring

    Filter by reward status. Valid values: Pending, Processing, Issued.

  • dateFromstring

    Show rewards created after this date (ISO format or date string).

  • memberIdstring

    GUID identifier of the member to filter by.

  • programIdstring

    ID of the program, program name, or program title to filter by.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Email from Unsubscribe ListREFERRALROCK_POST_EMAIL_REMOVEUNSUBSCRIBEAcción

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.

Parámetros de entrada

  • emailstringObligatorio

    The email address to be removed from the unsubscribe list.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unsubscribe Email AddressREFERRALROCK_POST_EMAIL_UNSUBSCRIBEAcción

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

Parámetros de entrada

  • emailstringObligatorio

    Email address to unsubscribe from the mailing list.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Webhook SubscriptionREFERRALROCK_POST_HOOKSAcción

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.

Parámetros de entrada

  • eventstringObligatorioenum

    Event type to monitor. Valid values: ProgramAdd, MemberAdd, MemberUpdate, MemberDelete, ReferralAdd, ReferralStatusChange, ReferralUpdate, ReferralDelete, RewardAdd, RewardIssue, or EmailUnsubscribed.

    ProgramAddMemberAddMemberUpdateMemberDeleteReferralAddReferralStatusChangeReferralUpdateReferralDeleteRewardAddRewardIssueEmailUnsubscribed
  • target_urlstringObligatorio

    The callback URL that receives event notifications via POST requests with JSON data.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Invite Feed EntryREFERRALROCK_POST_INVITEFEEDAcción

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.

Parámetros de entrada

  • emailstringObligatorio

    Contact's email address.

  • lastNamestringObligatorio

    Contact's last name.

  • firstNamestringObligatorio

    Contact's first name.

  • contactTypestring

    Optional contact type identifier to declare the API event where the contact originates.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Invite Feed EntriesREFERRALROCK_POST_INVITEFEEDSAcción

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.

Parámetros de entrada

  • inviteFeedsobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Member Access TokenREFERRALROCK_POST_MEMBERACCESSAcción

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.

Parámetros de entrada

  • memberQuerystringObligatorio

    Member Query. Check by Member Id, referral code, email address or External Id.

  • expireInMinutesinteger

    Number of minutes for the expiration of the member access URLs. Default 20 minutes if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Generate Member Access URLsREFERRALROCK_POST_MEMBER_ACCESS_URLSAcción

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.

Parámetros de entrada

  • memberIdstring

    Internal member ID (36 characters). One of four identifiers required.

  • externalIdstring

    External system ID (0-100 characters). One of four identifiers required.

  • emailAddressstring

    Member's email address (0-100 characters). One of four identifiers required.

  • referralCodestring

    Member's referral code (0-50 characters). One of four identifiers required.

  • expireInMinutesinteger

    Link expiration time in minutes (5-43200). Defaults to 20 minutes if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add new member to programREFERRALROCK_POST_MEMBERSAcción

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.

Parámetros de entrada

  • citystring

    City name.

  • emailstringObligatorio

    Member's email address.

  • phonestring

    Contact phone number.

  • countrystring

    Country name.

  • lastNamestring

    Member's surname.

  • passwordstring

    Member account password. If not provided, member will need to reset password on first login.

  • firstNamestringObligatorio

    Member's first name.

  • programIdstringObligatorio

    Program identifier for membership. This is the GUID of the program to which the member will be added.

  • payoutInfoobject

    Payment configuration object for member rewards.

  • postalCodestring

    Postal or ZIP code.

  • dateOfBirthstring

    Birth date in ISO format (YYYY-MM-DD).

  • addressLine1string

    Primary address line.

  • addressLine2string

    Secondary address line (apartment, suite, etc.).

  • disabledFlagboolean

    Membership activation status. Set to true to create the member in a disabled state.

  • referralCodestring

    Custom referral identifier. If not provided, one will be auto-generated.

  • customText1Namestring

    Custom text field name for additional member data.

  • customText2Namestring

    Second custom text field name for additional member data.

  • shouldSendEmailboolean

    Triggers confirmation email; defaults to false. Set to true to send a welcome email to the new member.

  • customText1Valuestring

    Custom text field value for customText1Name.

  • customText2Valuestring

    Second custom text field value for customText2Name.

  • customOption1Namestring

    Custom field name for additional member data.

  • customOverrideURLstring

    Branded URL override for the member's referral links.

  • recruiterSourceIdstring

    Associated recruiter ID (GUID). Either this or recruiterAssignedId is conditionally required if the program requires a recruiter.

  • countrySubdivisionstring

    State or province designation.

  • customOption1Valuestring

    Custom field value for customOption1Name.

  • externalIdentifierstring

    External system link identifier for integration purposes.

  • recruiterAssignedIdstring

    Currently assigned recruiter ID (GUID). Either this or recruiterSourceId is conditionally required if the program requires a recruiter.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Members from ProgramREFERRALROCK_POST_MEMBERS_REMOVEAcción

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.

Parámetros de entrada

  • membersobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Referral ActionREFERRALROCK_POST_REFERRALACTIONAcción

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.

Parámetros de entrada

  • namestring

    Identifier for the referral action. Optional name to describe the action.

  • amountnumberObligatorio

    Referral action amount, used for calculating percentage based recurring rewards

  • programQuerystring

    Search by program ID, name, or title. Optional parameter to specify the program.

  • referralQuerystringObligatorio

    Lookup mechanism using ReferralID, email, or External ID

  • externalIdentifierstring

    External ID, used for preventing duplicates and referencing original source. Optional unique identifier from external system.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove ReferralREFERRALROCK_POST_REFERRAL_REMOVEAcción

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

Parámetros de entrada

  • referralsobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create New ReferralREFERRALROCK_POST_REFERRALSAcción

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.

Parámetros de entrada

  • citystring

    City name.

  • notestring

    Internal notes about the referral. Not visible to the referral.

  • emailstring

    Referral's email address.

  • amountany

    Order total or transaction value.

  • regionstring

    State/province/region.

  • statusstringenum

    Referral state. Allowed values: 'pending', 'qualified', 'approved', or 'denied'.

    pendingqualifiedapproveddenied
  • countrystring

    Country name.

  • lastNamestring

    Referral's surname.

  • firstNamestring

    Referral's given name.

  • postalCodestring

    ZIP/postal code.

  • publicNotestring

    Publicly visible referral notes.

  • companyNamestring

    Business name.

  • phoneNumberstring

    Customer contact number.

  • addressLine1string

    Street address line 1.

  • addressLine2string

    Street address line 2 (apartment, suite, etc.).

  • referralCodestringObligatorio

    The referral code from the member that introduced the referral. This is required to associate the referral with a specific member.

  • customText1Namestring

    Custom text 1 field name.

  • customText2Namestring

    Custom text 2 field name.

  • customText3Namestring

    Custom text 3 field name.

  • customText1Valuestring

    Custom text 1 field value.

  • customText2Valuestring

    Custom text 2 field value.

  • customText3Valuestring

    Custom text 3 field value.

  • preferredContactstringenum

    Contact preference. Allowed values: 'email', 'callMorning', 'callAfternoon', or 'callEvening'.

    emailcallMorningcallAfternooncallEvening
  • customOption1Namestring

    Custom option 1 field name.

  • customOption2Namestring

    Custom option 2 field name.

  • customOption1Valuestring

    Custom option 1 field value.

  • customOption2Valuestring

    Custom option 2 field value.

  • externalIdentifierstring

    Unique external identifier you can use to later reference the referral.

  • recruiterAssignedIdstringuuid

    Currently assigned recruiter identifier (GUID format).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Referral StatusREFERRALROCK_POST_REFERRALS_STATUSAcción

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.

Parámetros de entrada

  • amountany

    Referral reward amount as a decimal value

  • statusstringObligatorio

    New status value for the referral. Must be one of: 'pending', 'qualified', 'approved', or 'denied'

  • programIdstring

    Identifier of the associated program

  • publicNotestring

    Customer-facing note about the status update

  • referralIdstringObligatorio

    Identifier for the referral to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Referral DetailsREFERRALROCK_POST_REFERRAL_UPDATEAcción

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.

Parámetros de entrada

  • updatesobject[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Issue Reward to MemberREFERRALROCK_POST_REWARDS_ISSUEAcción

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.

Parámetros de entrada

  • notestring

    A message sent to the reward recipient.

  • rewardIdstringObligatorio

    The unique identifier for the reward being issued.

  • recipientInfostring

    For PayPal, include the email address of the recipient. (Deprecated parameter)

  • overrideIneligibleboolean

    Allows you to override eligibility date rules. Issue rewards with eligibility dates in the future.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove RewardsREFERRALROCK_POST_REWARDS_REMOVEAcción

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.

Parámetros de entrada

  • rewardIdsstring[]Obligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not