Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.mention-me.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

As part of the referral journey, customers being referred provide their email address before claiming their introductory reward. During this registration, they can opt in to receive marketing emails from you. Mention Me can send opted-in referees’ data directly to:
  • Your API endpoint — via a configurable HTTP call
  • Supported ESPs — Ometria or Dotdigital natively; other ESPs via webhook or the API option
To enable this feature, contact your Client Success Manager.

​
API Configuration

If you opt for Mention Me to send data directly to your API, a compatible HTTPS endpoint must be available. The following options are configurable:
​
URL
string
required
HTTPS only.
​
Method
string
required
POST or GET.
​
Payload type
string
required
json, form_param, or multipart.
​
Authentication
string
Basic auth, no auth, or header-based authentication.
​
Parameters
string
email, locale (supported in both body and headers).
Static parameters and headers can also be added.

​
Supported Parameters

The following data is available for each opted-in referee:
​
email
string
Referee’s email address.
​
locale
string
Locale code. Example: en_GB
​
reward_expiry_date
string
When the referee’s reward expires.
​
coupon_code
string
The coupon code issued to the referee.
​
reward
string
Reward description.
​
referrer_firstname
string
First name of the person who referred them.
​
reward_currency
string
Currency of the reward.
​
segment
string
Customer segment.
​
datetime_subscribed
string
When the referee opted in.
​
type
string
Event type identifier.

​
Examples

​
POST JSON with header authentication

URL: https://example.com Body: 
{
    "email": "referee-email@example.com",
    "locale": "en_GB",
    "source": "MentionMe"
}
Headers: 
X-auth-token: 123abc-secret-token

​
GET with basic authentication

URL: 
https://username:password@example.com?email=referee-email%40example.com&locale=en_GB&other-param=example
Last modified on March 31, 2026