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
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.
Version
v2, v1 v2|v1Information to retrieve an offer entry point URL
Information about the referrer
Information about the request
Information about the order (used for recording order events AND segmentation)
Information about the address of the customer
Options for the implementation
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."