Add subscriber
referralhero_add_subscriberWRITE: add a subscriber (or a referred person) to a campaign. Give the campaign's unique identifier (email, phone, wallet or custom id). By default ReferralHero sends the subscriber a confirmation (double opt-in) email and any welcome automation of the campaign: set double_optin=false to suppress the confirmation email. Set referrer (a referral code or the referrer's email) to credit a referral. POST /lists/{uuid}/subscribers.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Subscriber name. | |
| tags | No | Tags to assign. | |
| uuid | Yes | Campaign (list) uuid, the 12-character id starting with MF (see referralhero_list_campaigns). | |
| No | Subscriber email (when email is the campaign's unique identifier). | ||
| device | No | Device used to sign up, for analytics. | |
| domain | No | URL used for the subscriber's referral link. | |
| points | No | Starting points (contest campaigns only). | |
| source | No | Source, for analytics. | |
| status | No | custom_event_pending = set the referral status to pending (multi-step goals). | |
| confirm | Yes | Must be true: the user has approved this change. It can unlock rewards and make ReferralHero email or text the subscriber or referrer (automations). | |
| referrer | No | Referral code or email of the referrer to credit. | |
| extra_field | No | Extra field value. | |
| double_optin | No | false = do not send the confirmation email. Default: the campaign's setting (usually sends it). | |
| phone_number | No | Subscriber phone number (when phone is the unique identifier). | |
| advocate_name | No | Name of the advocate. | |
| extra_field_2 | No | Extra field 2 value. | |
| transaction_id | No | Unique id of the purchase this referral came from. | |
| conversion_value | No | Monetary value of the referral. | |
| stripe_customer_id | No | Stripe customer id to link. | |
| conversion_category | No | Subscriber type for reports and segments. | |
| self_reported_source | No | Where the subscriber says they heard about the campaign. | |
| crypto_wallet_address | No | Wallet address (when it is the unique identifier). | |
| other_identifier_value | No | Custom identifier value (when a custom id is the unique identifier). |