---
title: "Enrol a customer in an offer"
method: POST
path: "/api/entry-point/{version}/offer"
tags: ["Referrer"]
---

# Enrol a customer in an offer

`POST /api/entry-point/{version}/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

## Path parameters

- `version` 'v2' | 'v1', required

## Request body

- EntryPointForReferrerType
  - `customer` CustomerDetails, required
    - `emailAddress` string, required — Customer email address
    - `title` string — Customer title such as Mr, Miss, Dr or Sir
    - `firstname` string, required — Customer firstname
    - `surname` string, required — Customer surname
    - `uniqueIdentifier` string — Your unique identifier for this customer e.g. CustomerId
    - `segment` string — Customer segment - a string containing segment data about this customer, e.g. vip or employee. You can concatenate multiple segments together if you wish using hyphens.
    - `customField` string — Custom field - a string containing custom data about this customer, e.g. SEGMENT001 or Package B
    - `visitorId` string — The visitor ID from the MentionMe Browser Fingerprint, used to link customer journeys. This should be a SHA256 hash (browserId + clientIP).
  - `request` RequestWithVariation, required
    - `partnerCode` string, required — Your partner code, used to link to your users and offers
    - `situation` string, required — Situation - a string representing where in the application you are making this request
    - `segment` string — Segment - the segment the customer belongs to
    - `localeCode` string, required — Locale code - ISO standard locale code (e.g. en_GB) for the locale you expect the content to be in
    - `ipAddress` string — IP address of the customer connection. If you're making a request on behalf of a customer, pass their IP address here. If the customer will connect directly, leave this empty and we will retrieve this from their request.
    - `userDeviceIdentifier` string — User Device Identifier should be a unique reference to this device. We use this for preventing gaming. Multiple users with the same Device Identifier will be treated as the same individual and may be flagged for gaming. On Android the UniqueID could be an InstanceID or GUID. On iPhone the UniqueID should be generated by identifierForVendor.
    - `deviceType` string — Device type - your description of the device the user is using. We use this for performance and conversion optimisation.
    - `appName` string — Your application name. Used for reporting.
    - `appVersion` string — Your application version reference. Used for reporting and troubleshooting.
    - `variation` string — Variation - an index (0,1,2...) specifying which of the currently running AB tests to choose (if available)
  - `order` OrderDetails
    - `orderIdentifier` string, required — Your Order Identifier for the transaction that has taken place
    - `total` string, required — Order subtotal, excluding tax and shipping in the currency specified by currencyCode
    - `currencyCode` string, required — 3 letter currency code for the currency in which the transaction took place. Use the ISO4217 format (e.g. GBP, EUR, etc
    - `dateString` string, required — The date on which the transaction took place (typically the current date/time). Use ISO8601 format (e.g. 2016-11-30T17:52:50Z)
    - `couponCode` string — If a coupon was used in the transaction, the coupon code the consumer used. If multiple coupons were used, pass them as a comma separated list. Leave blank if no coupon was used.
    - `discountAmount` 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.
    - `orderItemCount` string — The number of items in the order/cart (if applicable). This helps us understand the type of purchase and can be a signal of advocacy.
    - `isSubscription` boolean — Whether this order is for a subscription (recurring). This helps us qualify and categorise the revenue.
    - `isGift` boolean — Whether this order is a gift (being bought for someone else). Gifts can be signals of advocacy.
  - `address` Address
    - `addressLine1` string — First line of address
    - `addressLine2` string — Second line of address
    - `addressCity` string — City part of address
    - `addressCounty` string — County or state part of address
    - `addressPostCode` string — Post or ZIP code
    - `addressCountry` string — Country of address
  - `implementation` ImplementationDetails
    - `wrapContentWithBranding` boolean — If true (default), serve content in the URLs with customisable branding wrapper (normally a logo and padding). If false, serve content without any wrapping.
    - `showCloseIcon` boolean — If true (and the page is rendered inside an iframe), Mention Me will include a close icon. A user clicking on the close icon will trigger a postMessage event which can be listened to for closing the iframe. Documentation is available at https://docs.mention-me.com/developer-docs/advanced/postmessage-iframe

## Response `200`

Returned when successful

- EntryPointOfferAndLink
  - `url` string
  - `defaultCallToAction` string
  - `localeCode` string
  - `headline` string — e.g. "You can get a £20 gift card if you refer a friend to ..."
  - `description` string — e.g. "Give your friends a 20% off introductory offer"
  - `privacyNotice` string — e.g. "Our refer-a-friend programme is managed by Mention Me who will process your data and send you referral service emails."
  - `privacyNoticeUrl` string
  - `privacyNoticeLinkText` string
  - `imageUrl` string
  - `offerCode` string
  - `termsAndConditionsUrl` string

## Other 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

---

[API](https://skmtc.dev/mention-me/apis/auth-api.md) · [All operations](https://skmtc.dev/mention-me/apis/auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mention-me/auth-api/revisions/cdad84f071bd/schema)