Referral Settings
Where each referral setting lives — the capture channel list, program-level behaviour, fraud rules, and the tenant-wide defaults set over the API
Referral behaviour is set in three places in the app, plus a small set of tenant-wide defaults that your account team sets over the API. This page maps them.
Settings → Loyalty → Referral
Setting | Your options | Default |
|---|---|---|
Capture channels | The list of channel names programs pick from and captures name; type a name and press Enter; each up to 60 characters, unique ignoring case | Empty |
A public form or an integration sends this exact name with every capture it makes. Removing a channel here does not change programs already using it; it only leaves the picker. A capture that names a channel no program lists still lands and follows that program's default approval.
Per Program
Everything else a program needs is on its own settings page — channels and approval by channel, consent, the attribution window, the auto-enrol event, tag rules, the code format, and the Advanced section (pause behaviour, the approval default, who may decide reviews, segment thresholds). See Programs & Milestones.
Settings → Fraud Rules
The fraud switch, velocity limit and window, self-referral block, action, severity and the allow and block lists. See Approvals & Fraud Review.
Tenant-Wide Defaults (API)
A few defaults apply across programs and are set by your account team rather than in the app:
Setting | What it does | Default |
|---|---|---|
Referrals enabled | The master switch for referral capture and rewards | Off |
Require approval | Every capture without a channel rule waits for a reviewer, whatever the program's default | Off |
Consent required | Whether a new program starts with consent required; the program can override | Off |
Consent OTP template | The WhatsApp template that carries the referee's consent code | — |
Default attribution window | The window a new program starts with | 30 days |
Reversal events | Event types that undo a conversion — a refund, a cancellation — and reverse the rewards the matching stage fired | None |
Pause behaviour default | What a new program starts with for When paused | Freeze |
Segment thresholds default | Top-referrer conversions and lapse days a new program starts with | 5 conversions; 60 days |
For developers
Last updated on