v1

latestOpenAPI 3.0.02026-07-22207183.5 KB

Find referrer by name

Find a friend content

Fetch details from Mention Me with which to build a "find a friend" page. This will include an initial CTA, such as "Been referred by a friend?" as well as specific content which you can use to build the page.

Using this API to build your content will allow you to keep your content up to date with the latest content managed in Mention Me.

You should call this API once when your page is loaded, e.g. on the checkout page, and use it to populate the page.

get/api/consumer/{version}/referrer/search/content

Path parameters

version'v2' | 'v1' required

Version

Query parameters

request[partnerCode]string required

Your partner code, used to link to your users and offers

request[situation]string required

Situation - a string representing where in the application you are making this request

request[localeCode]string required

Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in

request[userDeviceIdentifier]string

User Device Identifier should be a unique reference to this combination of app + user.

request[deviceType]string

Device type - your description of the device the user is using. We use this for performance and conversion optimisation.

request[appName]string

Your application name. Used for reporting.

request[appVersion]string

Your application version reference. Used for reporting and troubleshooting.

Response

Returned when successful

entryCtastring

e.g. "Been referred by a friend?"

headlinestring

e.g. "Who referred you to us?"

searchTextstring

e.g. "Enter your friends name so we can thank them for referring you to us."

searchCtastring

e.g. "Find them"

nameInputPlaceholderstring

e.g. "Your friend's name"

emailInputPlaceholderstring

e.g. "Your friend's email"