Skip to main content

​
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:
​
string
required
HTTPS only.
​
string
required
POST or GET.
​
string
required
json, form_param, or multipart.
​
string
Basic auth, no auth, or header-based authentication.
​
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:
​
string
Referee’s email address.
​
string
Locale code. Example: en_GB
​
string
When the referee’s reward expires.
​
string
The coupon code issued to the referee.
​
string
Reward description.
​
string
First name of the person who referred them.
​
string
Currency of the reward.
​
string
Customer segment.
​
string
When the referee opted in.
​
string
Event type identifier.

​
Examples

​
POST JSON with Header Authentication

URL: https://example.com Body:
Headers:

​
GET with Basic Authentication

URL:
Last modified on July 13, 2026