Enrol a customer in an offer
curl --request POST \
--url https://mention-me.com/api/entry-point/{version}/offer \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"emailAddress": "jane.doe@example.com",
"firstname": "",
"surname": "",
"title": "",
"uniqueIdentifier": "",
"segment": "",
"customField": "",
"visitorId": ""
},
"request": {
"partnerCode": "[YOUR-PARTNER-CODE]",
"situation": "mobile-app",
"localeCode": "en_GB",
"segment": "vip",
"ipAddress": "127.0.0.1",
"userDeviceIdentifier": "",
"deviceType": "",
"appName": "",
"appVersion": "e.g. MyApp/v1.73",
"variation": ""
},
"address": {
"addressLine1": "",
"addressLine2": "",
"addressCity": "",
"addressCounty": "",
"addressPostCode": "",
"addressCountry": ""
},
"implementation": {
"wrapContentWithBranding": true,
"showCloseIcon": false
}
}
'import requests
url = "https://mention-me.com/api/entry-point/{version}/offer"
payload = {
"customer": {
"emailAddress": "jane.doe@example.com",
"firstname": "",
"surname": "",
"title": "",
"uniqueIdentifier": "",
"segment": "",
"customField": "",
"visitorId": ""
},
"request": {
"partnerCode": "[YOUR-PARTNER-CODE]",
"situation": "mobile-app",
"localeCode": "en_GB",
"segment": "vip",
"ipAddress": "127.0.0.1",
"userDeviceIdentifier": "",
"deviceType": "",
"appName": "",
"appVersion": "e.g. MyApp/v1.73",
"variation": ""
},
"address": {
"addressLine1": "",
"addressLine2": "",
"addressCity": "",
"addressCounty": "",
"addressPostCode": "",
"addressCountry": ""
},
"implementation": {
"wrapContentWithBranding": True,
"showCloseIcon": False
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
customer: {
emailAddress: 'jane.doe@example.com',
firstname: '',
surname: '',
title: '',
uniqueIdentifier: '',
segment: '',
customField: '',
visitorId: ''
},
request: {
partnerCode: '[YOUR-PARTNER-CODE]',
situation: 'mobile-app',
localeCode: 'en_GB',
segment: 'vip',
ipAddress: '127.0.0.1',
userDeviceIdentifier: '',
deviceType: '',
appName: '',
appVersion: 'e.g. MyApp/v1.73',
variation: ''
},
address: {
addressLine1: '',
addressLine2: '',
addressCity: '',
addressCounty: '',
addressPostCode: '',
addressCountry: ''
},
implementation: {wrapContentWithBranding: true, showCloseIcon: false}
})
};
fetch('https://mention-me.com/api/entry-point/{version}/offer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mention-me.com/api/entry-point/{version}/offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer' => [
'emailAddress' => 'jane.doe@example.com',
'firstname' => '',
'surname' => '',
'title' => '',
'uniqueIdentifier' => '',
'segment' => '',
'customField' => '',
'visitorId' => ''
],
'request' => [
'partnerCode' => '[YOUR-PARTNER-CODE]',
'situation' => 'mobile-app',
'localeCode' => 'en_GB',
'segment' => 'vip',
'ipAddress' => '127.0.0.1',
'userDeviceIdentifier' => '',
'deviceType' => '',
'appName' => '',
'appVersion' => 'e.g. MyApp/v1.73',
'variation' => ''
],
'address' => [
'addressLine1' => '',
'addressLine2' => '',
'addressCity' => '',
'addressCounty' => '',
'addressPostCode' => '',
'addressCountry' => ''
],
'implementation' => [
'wrapContentWithBranding' => true,
'showCloseIcon' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mention-me.com/api/entry-point/{version}/offer"
payload := strings.NewReader("{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mention-me.com/api/entry-point/{version}/offer")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mention-me.com/api/entry-point/{version}/offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"url": "<string>",
"defaultCallToAction": "",
"localeCode": "<string>",
"headline": "<string>",
"description": "<string>",
"privacyNotice": "<string>",
"privacyNoticeUrl": "<string>",
"privacyNoticeLinkText": "<string>",
"imageUrl": "<string>",
"offerCode": "<string>",
"termsAndConditionsUrl": "<string>"
}Referrer promotion
Enrol a customer in an offer
Provide a customers’ details so we can tell you if we could enrol them into an offer. We’ll provide the URL to the web-view for their journey.
Given a set of input parameters about the customer (and segment and any order that has just taken place), decide if we could enrol them as a customer and if so, give you a link to the web view so they can share the offer - whether referral, IFA or NPS - with their friends.
We encourage you to include the details of any order which has just taken place as this helps us with segmentation and propensity modelling. You can tell us about orders separately too.
You can present this as a button, link or broader display panel. We include other useful content which you can choose to present to the customer to give them a richer invitation to join the promotion programme. A headline and description describe the offer and the default CTA text gives you content to add to the link or button. There is also an optional image URL. There is also an optional privacy information notice if you need it.
Users of the Mention Me platform can configure and edit the content and image returned and those can be AB tested also - for example half the customers see one image and one set of content and half see another so that you can test how offers perform.
Note: you can also use /api/entry-point/{version}/referrer as the endpoint, which is an alias of this path
POST
/
api
/
entry-point
/
{version}
/
offer
Enrol a customer in an offer
curl --request POST \
--url https://mention-me.com/api/entry-point/{version}/offer \
--header 'Content-Type: application/json' \
--data '
{
"customer": {
"emailAddress": "jane.doe@example.com",
"firstname": "",
"surname": "",
"title": "",
"uniqueIdentifier": "",
"segment": "",
"customField": "",
"visitorId": ""
},
"request": {
"partnerCode": "[YOUR-PARTNER-CODE]",
"situation": "mobile-app",
"localeCode": "en_GB",
"segment": "vip",
"ipAddress": "127.0.0.1",
"userDeviceIdentifier": "",
"deviceType": "",
"appName": "",
"appVersion": "e.g. MyApp/v1.73",
"variation": ""
},
"address": {
"addressLine1": "",
"addressLine2": "",
"addressCity": "",
"addressCounty": "",
"addressPostCode": "",
"addressCountry": ""
},
"implementation": {
"wrapContentWithBranding": true,
"showCloseIcon": false
}
}
'import requests
url = "https://mention-me.com/api/entry-point/{version}/offer"
payload = {
"customer": {
"emailAddress": "jane.doe@example.com",
"firstname": "",
"surname": "",
"title": "",
"uniqueIdentifier": "",
"segment": "",
"customField": "",
"visitorId": ""
},
"request": {
"partnerCode": "[YOUR-PARTNER-CODE]",
"situation": "mobile-app",
"localeCode": "en_GB",
"segment": "vip",
"ipAddress": "127.0.0.1",
"userDeviceIdentifier": "",
"deviceType": "",
"appName": "",
"appVersion": "e.g. MyApp/v1.73",
"variation": ""
},
"address": {
"addressLine1": "",
"addressLine2": "",
"addressCity": "",
"addressCounty": "",
"addressPostCode": "",
"addressCountry": ""
},
"implementation": {
"wrapContentWithBranding": True,
"showCloseIcon": False
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
customer: {
emailAddress: 'jane.doe@example.com',
firstname: '',
surname: '',
title: '',
uniqueIdentifier: '',
segment: '',
customField: '',
visitorId: ''
},
request: {
partnerCode: '[YOUR-PARTNER-CODE]',
situation: 'mobile-app',
localeCode: 'en_GB',
segment: 'vip',
ipAddress: '127.0.0.1',
userDeviceIdentifier: '',
deviceType: '',
appName: '',
appVersion: 'e.g. MyApp/v1.73',
variation: ''
},
address: {
addressLine1: '',
addressLine2: '',
addressCity: '',
addressCounty: '',
addressPostCode: '',
addressCountry: ''
},
implementation: {wrapContentWithBranding: true, showCloseIcon: false}
})
};
fetch('https://mention-me.com/api/entry-point/{version}/offer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mention-me.com/api/entry-point/{version}/offer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'customer' => [
'emailAddress' => 'jane.doe@example.com',
'firstname' => '',
'surname' => '',
'title' => '',
'uniqueIdentifier' => '',
'segment' => '',
'customField' => '',
'visitorId' => ''
],
'request' => [
'partnerCode' => '[YOUR-PARTNER-CODE]',
'situation' => 'mobile-app',
'localeCode' => 'en_GB',
'segment' => 'vip',
'ipAddress' => '127.0.0.1',
'userDeviceIdentifier' => '',
'deviceType' => '',
'appName' => '',
'appVersion' => 'e.g. MyApp/v1.73',
'variation' => ''
],
'address' => [
'addressLine1' => '',
'addressLine2' => '',
'addressCity' => '',
'addressCounty' => '',
'addressPostCode' => '',
'addressCountry' => ''
],
'implementation' => [
'wrapContentWithBranding' => true,
'showCloseIcon' => false
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mention-me.com/api/entry-point/{version}/offer"
payload := strings.NewReader("{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mention-me.com/api/entry-point/{version}/offer")
.header("Content-Type", "application/json")
.body("{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mention-me.com/api/entry-point/{version}/offer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"customer\": {\n \"emailAddress\": \"jane.doe@example.com\",\n \"firstname\": \"\",\n \"surname\": \"\",\n \"title\": \"\",\n \"uniqueIdentifier\": \"\",\n \"segment\": \"\",\n \"customField\": \"\",\n \"visitorId\": \"\"\n },\n \"request\": {\n \"partnerCode\": \"[YOUR-PARTNER-CODE]\",\n \"situation\": \"mobile-app\",\n \"localeCode\": \"en_GB\",\n \"segment\": \"vip\",\n \"ipAddress\": \"127.0.0.1\",\n \"userDeviceIdentifier\": \"\",\n \"deviceType\": \"\",\n \"appName\": \"\",\n \"appVersion\": \"e.g. MyApp/v1.73\",\n \"variation\": \"\"\n },\n \"address\": {\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressCity\": \"\",\n \"addressCounty\": \"\",\n \"addressPostCode\": \"\",\n \"addressCountry\": \"\"\n },\n \"implementation\": {\n \"wrapContentWithBranding\": true,\n \"showCloseIcon\": false\n }\n}"
response = http.request(request)
puts response.read_body{
"url": "<string>",
"defaultCallToAction": "",
"localeCode": "<string>",
"headline": "<string>",
"description": "<string>",
"privacyNotice": "<string>",
"privacyNoticeUrl": "<string>",
"privacyNoticeLinkText": "<string>",
"imageUrl": "<string>",
"offerCode": "<string>",
"termsAndConditionsUrl": "<string>"
}Path Parameters
Version
Available options:
v2, v1 Pattern:
v2|v1Body
application/json
Information to retrieve an offer entry point URL
Information about the referrer
Show child attributes
Show child attributes
Information about the request
Show child attributes
Show child attributes
Information about the order (used for recording order events AND segmentation)
Show child attributes
Show child attributes
Information about the address of the customer
Show child attributes
Show child attributes
Options for the implementation
Show child attributes
Show child attributes
Response
Returned when successful
e.g. "You can get a £20 gift card if you refer a friend to ..."
e.g. "Give your friends a 20% off introductory offer"
e.g. "Our refer-a-friend programme is managed by Mention Me who will process your data and send you referral service emails."
Was this page helpful?