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.

​
What is the landing page used for?

When promoting your refer-a-friend programme, you are likely to want to lead your customers to landing pages on your site which include various pieces of Mention Me functionality. If you send out emails with a referral call to action you can direct your customers to a landing page on your own site. Create that page and embed on it a referrer offer tag. Unlike the referrer tag, the landing page tag does not require customer or order details — making it suitable for standalone promotional pages, email links, or social campaigns.

​
How to integrate the landing page tag

1

Create a new page on your website

Create a dedicated page on your site where customers will land when they click a referral promotion link (e.g. from an email or social post).
2

Add the wrapper div

Include the following <div> into your page where you want the referral content to appear.
<!-- Begin Mention Me referrer placeholder div -->
<div id="mmWrapper"></div>
<!-- End Mention Me referrer placeholder div -->
This is just a placeholder which is populated via the JavaScript tag. You can optionally apply a class or style to the div, via the Mention Me dashboard, if you wish to control the way the contents are styled. If you need to change the id on the wrapper (for example if you need two tags on one page), you can customise from within the Mention Me dashboard.
3

Add the JavaScript tag

Include the following JavaScript snippet at the bottom of the <body> tag on your landing page. The request includes your unique partner code.
<!-- Begin Mention Me referrer integration -->
<script type="text/javascript"
  src="https://tag-demo.mention-me.com/api/v2/referreroffer/YOUR_PARTNER_CODE?situation=landingpage&locale=en_GB">
</script>
<!-- End Mention Me referrer integration -->
4

Customise the parameters

(Optional) Include data parameters if you have customer details available — this makes the process smoother for the customer.

​
Mandatory data parameters

​
situation
string
required
String indicator of where you are including this tag within your site. For landing pages, use landingpage. Has a maximum of 50 characters. Example: landingpage
​
locale
string
required
String representing the required locale for the campaign. Used to show the right locale (language, currency) for the user. The format should be ISO 639-1 language code, an underscore (_), then the ISO 3166-1 alpha-2 country code. Default is empty (which will result in a locale of en_GB being assumed). Example: en_GB
​
title
string
The customer’s title. This allows you to have more formal messaging in your flow. Has a maximum of 20 characters.
​
firstname
string
The customer’s firstname. Pre-fills the form if provided. Please URL encode.
​
surname
string
The customer’s surname. Please URL encode.
​
fullname
string
The customer’s full name. Please URL encode.
​
email
string
The customer’s email address. Please URL encode.
​
customer_id
string
The unique customer identifier from your system.
​
username
string
The customer’s username. Your account is set up for referrers to share using their username not full name. Please URL encode.
​
phone_number
string
The customer’s phone number(s). Pass as many phone numbers as you have as a comma-separated list. If you are passing any data which is not a digit (e.g. spaces, +‘s), these need to be URL encoded.
​
custom_field
string
Any piece of custom data you wish to pass to us.
​
custom_share_field
string
A piece of text you can use to pass into sharing widgets, such as what the user bought or how much they saved.
​
call_to_action_url
string
A URL to send users to after they are rewarded. Only functions on the embedded flow.
​
segment
string
String representing a customer segment (for example one of: men, women) used to pass segmentation data about your customer to us. Has a maximum of 50 characters.
​
implementation
string
Optionally override the way the flow is implemented (one of: link, form, embed). Default can also be set in the merchant dashboard. If in doubt, leave out.
Last modified on April 17, 2026