referralrock_list_programs
List referral 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.
输入参数countoffsetprogram
referralrock_get_program
Get referral program by name
One referral program by its exact name: id, active flag, offers and URLs. GET /api/program/getsingle.
输入参数name必填
referralrock_list_reward_rules
List program 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.
输入参数program_id必填
referralrock_list_members
List members (advocates)
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.
输入参数sortcountqueryoffsetdate_toprogramdate_fromshow_disabled
referralrock_get_member_stats
Get member statistics
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.
输入参数member必填time_period
referralrock_list_referrals
List referrals (leads)
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.
输入参数sortcountqueryoffsetstatusdate_toprogramdate_frommember_id
referralrock_get_referral
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.
输入参数emailexternal_idreferral_id
referralrock_list_rewards
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.
输入参数sortcountqueryoffsetstatusdate_toprogramdate_frommember_id
referralrock_list_pending_payouts
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.
输入参数recipient_idinclude_ineligible
referralrock_list_payout_transactions
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.
输入参数recipient_idtransaction_id
referralrock_create_member
Add a member to a program
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.
输入参数email必填phoneconfirmlast_namefirst_name必填program_id必填external_idreferral_codesend_confirmation_email
referralrock_update_member
Update a 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.
输入参数emaildisabledmember_idnew_emailnew_phoneprogram_idexternal_idprogram_namenew_last_namereferral_codenew_first_namenew_external_id
referralrock_create_referral
Add a 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.
输入参数noteemailphoneamountstatusconfirmlast_namefirst_nameexternal_idcompany_namereferral_code必填preferred_contact
referralrock_update_referral
Update a referral (status, amount, notes)
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.
输入参数noteemailamountstatusconfirmprogram_idexternal_idpublic_notereferral_idprogram_name
referralrock_record_customer
Record a customer purchase
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.
输入参数email必填phoneamountconfirm必填last_namefirst_nameexternal_idpurchase_date