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.

​
Why the referrer tag matters

Mention Me offers referral and influencer solutions. This essential tag allows us to show promotional offers and track customer activity.

​
What does the referrer tag do?

Promotes your referral programme

Personalised messages encouraging customers to refer.

Closes the loop for rewards

Tracks when referred friends buy so referrers get rewarded.

Tracks influencer campaigns

Logs follower transactions so influencers are rewarded accurately.

Supports other goals

Follow-up content like discounts or NPS surveys.

​
How to integrate the referrer tag

​
Verb aliases in the URL

The verb in the URL path (referreroffer) can be replaced with offer or conversion — all three behave identically. Pick whichever reads best in your codebase, for example /api/v2/conversion/YOUR_PARTNER_CODE?....

​
Mandatory data parameters

These are required to ensure that your referral programme runs correctly.
​
firstname
string
required
The customer’s firstname. Please URL encode. Example: Franklin
​
surname
string
required
The customer’s surname. Please URL encode. Example: McFly
​
email
string
required
The customer’s email address. Please URL encode. Example: franklinmcfly559@mention-me.com
​
order_number
string
required
The unique order identifier from your system. Has a maximum of 50 characters. Example: 8494024521
​
order_subtotal
string
required
The order subtotal (excluding VAT/taxes and shipping) in the currency indicated by the order_currency parameter. If you can’t remove VAT, let us know. Example: 106.75
​
order_currency
string
required
The three character (ISO 4217) currency code that the order total is in. Example: GBP
​
situation
string
required
String indicator of where you are including this tag within your site (for example: checkout, postpurchase, landingpage). Used for reporting. Has a maximum of 50 characters. Example: postpurchase
​
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 (e.g. fr_FR for French/France). Default is empty (which will result in a locale of en_GB being assumed). When launching your first referral programme, we recommend targeting your main regions/locales first, based on volume. You can also group together and target certain regions with the same campaign if using the same language and currency (e.g. en_EU for all countries that have English as their language and Euro as their currency). If your referral programme offers third-party vouchers (e.g. Amazon gift card), check if they can support the locales you’re promoting to. Example: en_GB
​
coupon_code
string
required
The coupon code used by the customer (if any). Example: ABC4577

​
Extra parameters to drive referral optimisation

Add these data parameters to significantly improve performance.
​
order_discount_amount
string
The discount amount — our assumption is this has already been taken off the order subtotal provided. This allows us to calculate the Cost Per Acquisition for referral. Example: 23.49
​
order_item_count
string
The number of items in the basket (if applicable). This helps us understand the type of purchase and can be a signal of advocacy. Example: 1
​
order_is_subscription
string
Whether this order is for a subscription (recurring). This helps us qualify and categorise the revenue. Example: false
​
order_is_gift
string
Whether this order is a gift (being bought for someone else). Gifts can be signals of advocacy. Example: false
​
customer_id
string
The unique customer identifier from your system. Example: MI1404024521

​
Extra parameters for product referral

If you are using Product Referral, add these parameters to your referrer tag to enable product-level conversion tracking. See the product referral instructions for full details.
​
product_ids
string
Comma-separated list of product IDs included in the order.
​
product_skus
string
Comma-separated list of product SKUs included in the order.
​
product_names
string
Comma-separated list of product names included in the order.
​
product_prices
string
Comma-separated list of product prices included in the order.
​
product_quantities
string
Comma-separated list of product quantities included in the order.
​
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.
​
title
string
The customer’s title. This allows you to have more formal messaging in your flow. Has a maximum of 20 characters.
​
fullname
string
The customer’s full name. Please URL encode.
​
username
string
The customer’s username. Your account is set up for referrers to share using their username not full name. Please URL encode.
​
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.
​
custom_field
string
Any piece of custom data you wish to pass to us.
​
address_line1
string
The customer’s address line 1 (if known).
​
address_line2
string
The customer’s address line 2 (if known).
​
address_city
string
The customer’s address city (if known).
​
address_county
string
The customer’s address county (if known).
​
address_postcode
string
The customer’s address postcode (if known).
​
address_country
string
The customer’s address country (if known).
​
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.
​
order_date
string
The date and time the order was placed. The format must be in ISO 8601 format and URL encoded. If not provided or invalid, we will use the date and time at the point we received the tag.
​
mm_encrypted
string
In some cases it may be desirable to ensure that email addresses and other information is not in clear text. See encrypted parameters.
​
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.
​
variation
string
Integer representing the index of an offer within an experiment. Used to override the dynamic allocation of offers to customers so that, for example, email creative can be set up to show a specific variation. Default is null.

​
Example with all mandatory parameters populated

<!-- Begin Mention Me referrer integration -->
<script type="text/javascript"
  src="https://tag-demo.mention-me.com/api/v2/referreroffer/YOUR_PARTNER_CODE?firstname=Franklin&surname=McFly&email=franklinmcfly559@mention-me.com&order_number=8494024521&order_subtotal=106.75&order_currency=GBP&situation=postpurchase&locale=en_GB&coupon_code=ABC4577&order_discount_amount=23.49&order_item_count=1&order_is_subscription=false&order_is_gift=false&customer_id=MI1404024521">
</script>
<!-- End Mention Me referrer integration -->

​
Things to watch out for

Check the browser developer console for errors from the Mention Me tag. Most integration issues come down to a missing mandatory parameter, an un-encoded value, or the demo host being left in the live snippet. See the common tag integration errors and error codes for the full checklist.
The most common reasons are that firstname and surname are not being rendered into the tag URL (the snippet still contains <INSERT_FIRSTNAME> / <INSERT_SURNAME>), or the values are not URL encoded. Customer names with accented characters or spaces must be URL encoded before being written into the URL.
order_subtotal must be the order subtotal excluding VAT/taxes and shipping — this is the figure the referral reward is calculated against. If you cannot remove VAT on your side, let your Client Success Manager know and we can handle the adjustment.
The referrer tag personalises the sharing experience using the customer’s real name (for example, “Franklin recommends…”). Without a name we cannot build that sharing message, which dramatically reduces referral performance. If your account is configured to share by username instead, use the username parameter — but the referral programme still needs a name for display in some flows.
Last modified on April 17, 2026