API Reference
Core APIUGC APIApp Developer APIHelp Center

Send Referral Emails

post
https://loyalty.yotpo.com/api/v2/referral/share

Sends referral invitations to a comma-separated list of addresses on the referrer's behalf. Invalid invitees are rejected with a per-address reason — SELF_REFERRAL and ALREADY_PURCHASED are the common ones; a 422 with NO_LEGITIMATE_EMAILS means every address was rejected. Treat rejections as user feedback rather than retrying. Requests are rate limited (429).

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. Required if no customer_id is passed.

string

The identifier used to uniquely identify the referring customer in your system. Required if no customer_email is passed.

string
required

Comma-separated list of email addresses to share the referral link to

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 14 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 14 days ago

Did this page help you?