Update a referral (status, amount, notes)
referralrock_update_referralWRITE: 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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | New private note. | |
| No | The referral's email address (needs program_id or program_name). | ||
| amount | No | New order amount / total (used for percentage rewards). | |
| status | No | New status. | |
| confirm | No | Must be true when status is qualified or approved, or amount is set: confirms rewards may be issued or changed. | |
| program_id | No | Program id; needed together with external_id or email (or give program_name). | |
| external_id | No | The referral's external identifier (needs program_id or program_name). | |
| public_note | No | New public note. | |
| referral_id | No | The referral's id (preferred). | |
| program_name | No | Program name; needed together with external_id or email (or give program_id). |