Skip to main content
POST
/
api
/
consumer
/
{version}
/
referee
/
register
Register referee
curl --request POST \
  --url https://mention-me.com/api/consumer/{version}/referee/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "referrerMentionMeIdentifier": "",
  "referrerToken": "",
  "customer": {
    "emailAddress": "jane.doe@example.com",
    "firstname": "",
    "surname": "",
    "title": "",
    "uniqueIdentifier": "",
    "segment": "",
    "customField": "",
    "visitorId": ""
  },
  "request": {
    "partnerCode": "[YOUR-PARTNER-CODE]",
    "situation": "mobile-app",
    "localeCode": "en_GB",
    "segment": "vip",
    "ipAddress": "127.0.0.1",
    "userDeviceIdentifier": "",
    "deviceType": "",
    "appName": "",
    "appVersion": "e.g. MyApp/v1.73"
  }
}
'
{
  "offer": {
    "id": 123,
    "localeCode": "<string>",
    "headline": "<string>",
    "description": "<string>",
    "callToAction": "<string>",
    "privacyNotice": "<string>",
    "privacyLink": "<string>",
    "referrerReward": {
      "description": "<string>",
      "summary": "<string>",
      "amount": "<string>"
    },
    "refereeReward": {
      "description": "<string>",
      "summary": "<string>",
      "amount": "<string>"
    }
  },
  "refereeReward": {
    "description": "<string>",
    "couponCode": "<string>",
    "securityCode": "<string>",
    "url": "<string>",
    "amount": "<string>"
  },
  "content": {
    "relationship": "content-collection",
    "resource": [
      {
        "key": "<string>",
        "content": "<string>"
      }
    ]
  },
  "termsLinks": {
    "localeCode": "<string>",
    "linkToTermsInLocale": "<string>"
  },
  "status": "<string>"
}

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.

Path Parameters

version
enum<string>
required

Version

Available options:
v2,
v1
Pattern: v2|v1

Body

application/json

Details of the new customer who has been referred

referrerMentionMeIdentifier
integer
required

Id representing the referrer returned by a successful name search

Example:

""

referrerToken
string
required

Token representing the referrer returned by a successful name search

Example:

""

customer
Customer · object
required

Information about the referee to register and give a reward

request
Request · object
required

Information about the request

Response

Returned when successful

offer
object
refereeReward
A description of the referee reward for the Referee · object
content
object
status
string
Last modified on March 31, 2026