---
updatedAt: 2026-08-26T15:29:24.000Z
agentTools:
  projectIndex: https://loyaltyapi.yotpo.com/llms.txt
---

# Send Referral Emails

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).

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "api-settings",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://loyalty.yotpo.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "X-API-KEY": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "description": "Your account API key can be found in the \"Settings\" section of your Yotpo loyalty admin. See [Yotpo Authentication](https://loyaltyapi.yotpo.com/reference/authentication) to learn how to generate your API key."
      },
      "X-GUID": {
        "type": "apiKey",
        "in": "header",
        "name": "X-GUID",
        "description": "The Globally Unique Identifier found in the \"Settings\" section of your Yotpo loyalty admin. See [Yotpo Authentication](https://loyaltyapi.yotpo.com/reference/authentication) to learn how to generate your GUID."
      }
    }
  },
  "security": [
    {
      "X-API-KEY": [],
      "X-GUID": []
    }
  ],
  "paths": {
    "/api/v2/referral/share": {
      "post": {
        "summary": "Send Referral Emails",
        "description": "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).",
        "operationId": "send-referral-emails",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "required": [
                  "email",
                  "emails"
                ],
                "properties": {
                  "email": {
                    "type": "string",
                    "description": "The email address of the referring customer. Required if no customer_id is passed."
                  },
                  "customer_id": {
                    "type": "string",
                    "description": "The identifier used to uniquely identify the referring customer in your system. Required if no customer_email is passed."
                  },
                  "emails": {
                    "type": "string",
                    "description": "Comma-separated list of email addresses to share the referral link to"
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "email": "referringcustomer@gmail.com",
                    "emails": "firstreferred@gmail.com,secondreferred@gmail.com"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          },
          "422": {
            "description": "422",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"error\": \"NO_LEGITIMATE_EMAILS\",\n  \"details\": {\n    \"email\": \"<fraudulent_email_address>\",\n    \"reason\": \"SELF_REFERRAL|ALREADY_PURCHASED\"\n    }\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "type": "object",
                      "properties": {
                        "errors": {
                          "type": "object",
                          "properties": {
                            "email": {
                              "type": "string",
                              "example": "email is a required field"
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "errors": {
                          "type": "object",
                          "properties": {
                            "emails": {
                              "type": "string",
                              "example": "emails is a required field"
                            }
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "error": {
                          "type": "string",
                          "example": "NO_REFERRER_FOUND"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "error": {
                          "type": "string",
                          "example": "NO_VALID_EMAILS"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "error": {
                          "type": "string",
                          "example": "NO_LEGITIMATE_EMAILS"
                        },
                        "details": {
                          "type": "object",
                          "properties": {
                            "email": {
                              "type": "string",
                              "example": "<fraudulent_email_address>"
                            },
                            "reason": {
                              "type": "string",
                              "example": "SELF_REFERRAL|ALREADY_PURCHASED"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "429": {
            "description": "429",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": "RATELIMIT_EXCEEDED"
                  }
                }
              }
            }
          }
        },
        "x-internal": false
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "value": "application/json",
        "key": "Content-Type"
      }
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```

# Sibling pages

* [Identify Referrer](https://loyaltyapi.yotpo.com/reference/identify-referrer.md)