Raw schema
{
"type": "object",
"properties": {
"uuid": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Campaign (list) uuid, the 12-character id starting with MF (see referralhero_list_campaigns)."
},
"email": {
"description": "Subscriber email (when email is the campaign's unique identifier).",
"type": "string",
"minLength": 3,
"maxLength": 320
},
"phone_number": {
"description": "Subscriber phone number (when phone is the unique identifier).",
"type": "string",
"minLength": 1,
"maxLength": 40
},
"crypto_wallet_address": {
"description": "Wallet address (when it is the unique identifier).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"other_identifier_value": {
"description": "Custom identifier value (when a custom id is the unique identifier).",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"name": {
"description": "Subscriber name.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"referrer": {
"description": "Referral code or email of the referrer to credit.",
"type": "string",
"minLength": 1,
"maxLength": 320
},
"double_optin": {
"description": "false = do not send the confirmation email. Default: the campaign's setting (usually sends it).",
"type": "boolean"
},
"confirm": {
"type": "boolean",
"const": true,
"description": "Must be true: the user has approved this change. It can unlock rewards and make ReferralHero email or text the subscriber or referrer (automations)."
},
"status": {
"description": "custom_event_pending = set the referral status to pending (multi-step goals).",
"type": "string",
"enum": [
"custom_event_pending"
]
},
"points": {
"description": "Starting points (contest campaigns only).",
"type": "integer",
"minimum": 0,
"maximum": 1000000000
},
"transaction_id": {
"description": "Unique id of the purchase this referral came from.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"conversion_category": {
"description": "Subscriber type for reports and segments.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"conversion_value": {
"description": "Monetary value of the referral.",
"type": "number",
"minimum": 0,
"maximum": 1000000000000
},
"source": {
"description": "Source, for analytics.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"device": {
"description": "Device used to sign up, for analytics.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"extra_field": {
"description": "Extra field value.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"extra_field_2": {
"description": "Extra field 2 value.",
"type": "string",
"minLength": 1,
"maxLength": 500
},
"domain": {
"description": "URL used for the subscriber's referral link.",
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"stripe_customer_id": {
"description": "Stripe customer id to link.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"advocate_name": {
"description": "Name of the advocate.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"self_reported_source": {
"description": "Where the subscriber says they heard about the campaign.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"tags": {
"description": "Tags to assign.",
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
}
},
"required": [
"uuid",
"confirm"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}