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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Version

Allowed:
Body Params

Information to retrieve an offer entry point URL

customer
required

Information about the referrer

request
required

Information about the request

order

Information about the order (used for recording order events AND segmentation)

address

Information about the address of the customer

implementation

Options for the implementation

Responses

404

Returned when this specific integration point has been disabled

422

The data presented contains validation errors, please correct and try again

500

Internal server error, unable to complete the request

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json