Referrers & Referral Codes
Enrolling a customer as a referrer, the code they share, code formats, look-ups and revoking
A referrer is a customer enrolled in a program. Enrolment issues them one personal code per program, and that code is what ties every referee back to them.
Enrolling a Referrer
How | What happens |
|---|---|
From a member's profile | Onboard as referrer (or Enroll in another program) — pick the program and the code is issued on the spot |
From Referrals → Leads | Add lead in New referrer mode: name, mobile and the program; the person joins as a referrer and gets their own code |
Automatically | When a program's Referee auto-enrol on names a moment — when captured, when the referral is accepted, when a stage fires — a referee becomes a referrer at that moment |
Over the API | The same enrolment, from your own systems — see the developer note below |
Enrolment is per program: a customer can be enrolled in several and holds a separate code in each. Enrolling someone who already has a code in that program returns their existing code — nothing is duplicated.
Sharing the Code
The code travels however your team prefers: read out at the counter, sent in a WhatsApp message, or embedded in the link to a public referral form so the referee's form arrives pre-filled. Whatever the route, the referee is captured against the code — see Capturing Referees.
Code Format
Each program decides what its codes look like, under Referral code on the program's settings page. Until you choose, a program issues eight random characters from the look-alike-free set with no prefix.
Field | Your options |
|---|---|
Prefix | Up to eight letters or digits, or none — “HOPE” gives codes like |
Generation | Random — unguessable codes / Sequential — codes issued in order (the page shows the last number issued) |
Characters | Digits only / Letters only / Letters and digits / Letters and digits, no look-alikes (no 0, O, 1, I, L) |
Length after prefix | Up to 12 characters; at least 4 for sequential codes, 5 for random ones, 6 for random digits |
The format is fixed once the first referrer is enrolled — the page locks it and shows what codes look like. Create a new program to use a different one.
Shorter and clearer wins
Looking Up a Referrer
Type a code into Add lead and the dialog checks it as you type, showing the owner's name and phone — or “No referrer found for this code.” A member's profile lists their code for every program they are enrolled in. Over the API, a lookup by code returns the single enrolment that owns it; a lookup by phone or lead returns every program the customer is enrolled in.
Revoking
Revoking an enrolment (over the API) retires the code: no new referee can be captured against it. Referrals already attributed to the referrer are unaffected — their milestones still fire and pay out.
For developers
Last updated on