referralrock_create_member

WRITE: creates a new member (advocate) in a referral program and returns the member with their referral code and share URL. Not idempotent: a repeat call may create a duplicate or fail. When send_confirmation_email is true Referral Rock emails the member the program's confirmation email, which is a message to a real person; the default is false. POST /api/members.

destructive

Argument	Type	Description
email*	string	Member email address.
phone	string	Member phone number.
confirm	boolean	Must be true when send_confirmation_email is true: confirms an email goes to the member.
last_name	string	Member last name.
first_name*	string	Member first name.
program_id*	string	Program id to add the member to (see referralrock_list_programs).
external_id	string	Your own id for this member, to link it to another system.
referral_code	string	A custom referral code; Referral Rock generates one when left out.
send_confirmation_email	boolean	Email the member the program's confirmation email (default false; needs confirm: true).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "program_id",
    "first_name",
    "email"
  ],
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "Member email address."
    },
    "phone": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "Member phone number."
    },
    "confirm": {
      "type": "boolean",
      "description": "Must be true when send_confirmation_email is true: confirms an email goes to the member."
    },
    "last_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Member last name."
    },
    "first_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Member first name."
    },
    "program_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Program id to add the member to (see referralrock_list_programs)."
    },
    "external_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Your own id for this member, to link it to another system."
    },
    "referral_code": {
      "type": "string",
      "maxLength": 50,
      "minLength": 1,
      "description": "A custom referral code; Referral Rock generates one when left out."
    },
    "send_confirmation_email": {
      "type": "boolean",
      "description": "Email the member the program's confirmation email (default false; needs confirm: true)."
    }
  }
}

referralrock_create_referral

WRITE: adds a referral (a lead) to the program of the member who owns the given referral code, as if the lead had used that member's link. A status of qualified or approved can trigger the program's configured rewards for the member, which is a financial commitment, so leave status out (new referrals start as pending) unless you mean it. Not idempotent. POST /api/referrals.

destructive

Argument	Type	Description
note	string	Private note tied to the referral.
email	string	Referral email address.
phone	string	Referral phone number.
amount	number	Order amount / total tied to the referral.
status	string	Initial status (default pending). qualified / approved may trigger rewards and need confirm: true.
confirm	boolean	Must be true when status is qualified or approved: confirms rewards may be issued.
last_name	string	Referral last name.
first_name	string	Referral first name.

referralrock_get_member_stats

Sharing, referral and reward statistics of one member over a time period: views, shares, referrals (pending / qualified / approved), reward amounts pending and issued, last share and activity dates. GET /api/memberstats/getsingle.

read-only

Argument	Type	Description
member*	string	The member's email address, id, external id or referral code.
time_period	string	All (default), MonthToDate, LastMonth, Last7Days or Last30Days.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "member"
  ],
  "properties": {
    "member": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The member's email address, id, external id or referral code."
    },
    "time_period": {
      "enum": [
        "All",
        "MonthToDate",
        "LastMonth",
        "Last7Days",
        "Last30Days"
      ],
      "type": "string",
      "description": "All (default), MonthToDate, LastMonth, Last7Days or Last30Days."
    }
  }
}

referralrock_get_program

One referral program by its exact name: id, active flag, offers and URLs. GET /api/program/getsingle.

read-only

Argument	Type	Description
name*	string	The program's exact name (see referralrock_list_programs).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The program's exact name (see referralrock_list_programs)."
    }
  }
}

referralrock_get_referral

One referral by id, email address or external id (at least one is required): status, amount, referring member, notes, custom fields and dates. GET /api/referral/single.

read-only

Argument	Type	Description
email	string	The referral's email address.
external_id	string	The referral's external identifier.
referral_id	string	The referral's id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "email": {
      "type": "string",
      "maxLength": 254,
      "minLength": 1,
      "description": "The referral's email address."
    },
    "external_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The referral's external identifier."
    },
    "referral_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "The referral's id."
    }
  }
}

referralrock_list_members

List members (the people who refer others), newest first by default, with their referral code and share URL, referral counts, rewards earned and activity dates. Filter by program, by an email / id / external id / referral code, by created date, or active vs disabled. GET /api/members.

read-only

Argument	Type	Description
sort	string	Sort order (default Create_Dt_Desc).
count	integer	Results per page, 1-200 (default 20).
query	string	A member's email address, id, external id or referral code.
offset	integer	Starting index, 0 based (default 0). Pass the previous reply's next_offset.
date_to	string	Only members created before this date (yyyy-mm-dd).
program	string	Program id, program name or program title.
date_from	string	Only members created after this date (yyyy-mm-dd).
show_disabled	boolean	true = disabled members, false = active members. Leave out for the default.

referralrock_list_payout_transactions

Payout transactions already transferred to program participants (type, amount, date, status, destination, vendor errors) and the balance left in the account to cover pending payouts. Optionally for one recipient or one transaction. GET /api/payouts/transactions.

read-only

Argument	Type	Description
recipient_id	string	Only the transactions paid to this recipient id.
transaction_id	string	Only this transaction id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "recipient_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the transactions paid to this recipient id."
    },
    "transaction_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only this transaction id."
    }
  }
}

referralrock_list_pending_payouts

Payouts that are owed but not yet transferred: recipient, program, number of rewards and total amount. Optionally for one recipient, and optionally including rewards whose eligibility date is still in the future. GET /api/payouts/pending.

read-only

Argument	Type	Description
recipient_id	string	Only the payouts owed to this recipient id.
include_ineligible	boolean	Also include payouts for rewards with an eligibility date in the future (default false).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "recipient_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the payouts owed to this recipient id."
    },
    "include_ineligible": {
      "type": "boolean",
      "description": "Also include payouts for rewards with an eligibility date in the future (default false)."
    }
  }
}

referralrock_list_programs

List the referral programs in the account: id, name, type (Web or Form), active flag, title, the member and referral offers and the share/widget URLs. Use the ids (or names) to filter members, referrals and rewards. GET /api/programs.

read-only

Argument	Type	Description
count	integer	Results per page, 1-200 (default 20).
offset	integer	Starting index, 0 based (default 0). Pass the previous reply's next_offset.
program	string	Only the program with this id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "count": {
      "type": "integer",
      "maximum": 200,
      "description": "Results per page, 1-200 (default 20).",
      "exclusiveMinimum": 0
    },
    "offset": {
      "type": "integer",
      "maximum": 10000000,
      "minimum": 0,
      "description": "Starting index, 0 based (default 0). Pass the previous reply's next_offset."
    },
    "program": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Only the program with this id."
    }
  }
}

referralrock_list_referrals

List referrals (the people members referred), newest first by default, with status (pending, qualified, approved, denied), amount, the referring member, notes and dates. Filter by program, status, referring member, free-text query or created date. GET /api/referrals.

read-only

Argument	Type	Description
sort	string	Sort order (default Create_Dt_Desc).
count	integer	Results per page, 1-200 (default 20).
query	string	A referral's email address, id, external id or referral code.
offset	integer	Starting index, 0 based (default 0). Pass the previous reply's next_offset.
status	string	Only referrals in this status.
date_to	string	Only referrals created before this date (yyyy-mm-dd).
program	string	Program id, program name or program title.
date_from	string	Only referrals created after this date (yyyy-mm-dd).
member_id

referralrock_list_reward_rules

The reward rules of one program: what triggers a reward (referral status, referral count or sales limits), how the amount is worked out (fixed or percent), the payout type and delivery delay. GET /api/rewardrules.

read-only

Argument	Type	Description
program_id*	string	Program id (a GUID; see referralrock_list_programs).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "program_id"
  ],
  "properties": {
    "program_id": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Program id (a GUID; see referralrock_list_programs)."
    }
  }
}

referralrock_list_rewards

List rewards, newest first by default: recipient, amount, status (Pending, Processing, Issued), payout type, eligibility and issue dates, the member and referral behind it. Filter by program, member, status, recipient query or created date. GET /api/rewards.

read-only

Argument	Type	Description
sort	string	Sort order (default Create_Dt_Desc).
count	integer	Results per page, 1-200 (default 20).
query	string	The recipient's email address, id, external id or member referral code.
offset	integer	Starting index, 0 based (default 0). Pass the previous reply's next_offset.
status	string	Only rewards in this status.
date_to	string	Only rewards created before this date (yyyy-mm-dd).
program	string	Program id, program name or program title.
date_from	string	Only rewards created after this date (yyyy-mm-dd).
member_id

referralrock_record_customer

WRITE: reports a paying customer to Referral Rock. A customer whose email matches a pending referral turns that referral to approved, which triggers the program's configured rewards for the referring member (a financial commitment that may be paid out automatically). A customer with no matching referral is added as a pre-loaded member to every program that has Preload New Customers on. Returns the outcome per customer (ReferralApproved, MemberPreloaded, Skipped…). Not idempotent. POST /api/customerfeed.

destructive

Argument	Type	Description
email*	string	The customer's email address; the match key against pending referrals and members.
phone	string	Customer phone number.
amount	number	Purchase amount; feeds percentage rewards (default 0).
confirm*	boolean	Must be true: confirms a matching pending referral may be approved and its rewards issued.
last_name	string	Customer last name.
first_name	string	Customer first name.
external_id	string	Your own id for this customer (for example a CRM id).

referralrock_update_member

WRITE: changes contact details of an existing member, or disables / re-enables the member (a disabled member can no longer take part in the programs). Only the fields you pass are changed. The member is found by id, referral code, or email / external id plus program_id or program_name; Referral Rock updates it only when it is uniquely identified. POST /api/members/update.

destructive

Argument	Type	Description
email	string	The member's current email address (needs program_id or program_name).
disabled	boolean	true disables the member, false re-enables.
member_id	string	The member's id (preferred).
new_email	string	New email address.
new_phone	string	New phone number.
program_id	string	Program id; needed together with email or external_id (or give program_name).
external_id	string	The member's current external identifier (needs program_id or program_name).
program_name	string	Program name; needed together with email or external_id (or give program_id).

referralrock_update_referral

WRITE: changes the status, amount or notes of an existing referral. Moving a referral to qualified or approved can trigger the program's configured rewards for the referring member (a financial commitment that may be paid out automatically), and denied stops them: confirm with the user first. Only the fields you pass are changed. The referral is found by id, or by external id / email plus program_id or program_name. POST /api/referral/update.

destructive

Argument	Type	Description
note	string	New private note.
email	string	The referral's email address (needs program_id or program_name).
amount	number	New order amount / total (used for percentage rewards).
status	string	New status.
confirm	boolean	Must be true when status is qualified or approved, or amount is set: confirms rewards may be issued or changed.
program_id	string	Program id; needed together with external_id or email (or give program_name).
external_id	string	The referral's external identifier (needs program_id or program_name).

Referral Rock MCP by usefulapi

Try it

referralrock_create_member Destructive

Referral Rock MCP by usefulapi

Try it

referralrock_create_member Destructive

Tools (15)