Add a referral
referralrock_create_referralWRITE: 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | Private note tied to the referral. | |
| No | Referral email address. | ||
| phone | No | Referral phone number. | |
| amount | No | Order amount / total tied to the referral. | |
| status | No | Initial status (default pending). qualified / approved may trigger rewards and need confirm: true. | |
| confirm | No | Must be true when status is qualified or approved: confirms rewards may be issued. | |
| last_name | No | Referral last name. | |
| first_name | No | Referral first name. | |
| external_id | No | Your own unique id for the referral (an order or customer id), to find it again. | |
| company_name | No | Company name. | |
| referral_code | Yes | The referral code of the member who introduced the referral (see referralrock_list_members). | |
| preferred_contact | No | Preferred way to contact the referral. |