The Referral API powers Uniqodo's referral programmes. A customer can become a referrer and invite their
friends, who receive a reward when they make a purchase.
The rewards on both sides are backed by promotions: a friend promotion for the reward the friend claims, and a referrer promotion for the reward the referrer earns. These can be configured independently. Each referral programme can also apply its own limits, such as how many referrals a referrer may make per day.
How it works
A customer registers as a referrer, then refers a friend. The friend receives a unique code. Once the friend
completes a purchase with that code on the merchant's website, the referrer is awarded their reward: a code for the referrer promotion, sent to them by email.
There are two ways to integrate this. Most merchants use the low-code route below. If you need full control,
you can integrate the Referral API endpoints directly.
Low-code route (recommended)
Merchants with Experience Builder enabled can run a referral programme with little or no direct integration
against the Referral API.
Onboarding referrers: customers are onboarded through a referral overlay, built and served through Experience Builder, so this part of the flow is handled there rather than against the Register a referrer endpoint.
Issuing friend codes: once registered, the referrer receives a link to a Uniqodo-hosted friend page that they
can share. When a friend lands on it, they enter their email and are issued a code directly, so there is no
need to integrate the Refer a friend endpoint.
Capturing the purchase: a friend's purchase is what triggers the referrer's reward. If you already send
transactions to the Events API's transaction endpoint, that captures friend purchases for you, with no
separate call needed.
Full control with the Referral API
If you'd prefer to integrate directly, the flow maps to three endpoints:
Register a referrer: register the customer as a referrer.
Refer a friend: issue a unique code to a friend. The register response also returns a link to the Uniqodo-hosted friend page, so you can let that page issue codes instead of calling this endpoint.
Capture a friend purchase: report the friend's purchase to trigger the referrer's reward. Most integrated merchants don't need this. If you already send transactions to the Events API's transaction endpoint,
capture happens automatically.