Identify Referrer

Finds or creates the customer as a referrer and returns their referral link along with their referral history — referral_receipts lists past sign-ups and completed referrals. Safe to call repeatedly; an existing referrer is returned, not duplicated.

Recipes
📨
Run a referral flow
Open Recipe
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The email address of the referring customer who needs the referral link.

string

Associates a first name with their Loyalty account. Important to include if you'd like to include first name in any marketing material

string

Associates a last name with their Loyalty account. Important to include if you'd like to include first name in any marketing material

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json