v1

latestOpenAPI 3.0.02026-07-22207183.5 KB

Dashboard

Get dashboard

Provide a customers' details so we can tell you if we could show them a dashboard (or offer). We'll provide the URL to the web-view for their dashboard.

Provide their full details (name, email, customerId) if you want us to optionally register them if they're not yet a referrer.

For information on how to correctly generate the Authentication Token, please see the documentation: https://docs.mention-me.com/api-reference/entry-point-api/authentication-token

post/api/entry-point/{version}/dashboard

Path parameters

version'v2' | 'v1' required

Version

Request body

Example request

{
  "customer": {
    "emailAddress": "jane.doe@example.com"
  },
  "request": {
    "partnerCode": "[YOUR-PARTNER-CODE]",
    "situation": "mobile-app",
    "segment": "vip",
    "localeCode": "en_GB",
    "ipAddress": "127.0.0.1",
    "appVersion": "e.g. MyApp/v1.73"
  }
}

Response

Returned when successful

urlstring

defaultCallToActionstring