API Reference
Engineering BlogHelp Centre

Register referee

post
https://mention-me.com/api/consumer//referee/register

After a successful response from the "Find friend" API, this endpoint allows you to register a new customer to confirm the relationship between the Referee (the friend) and the Referrer (the person who referred them).

Confirming the registration requires the referrerMentionMeIdentifier and referrerToken from the search API response.

To complete the registration, you will need to confirm the registration details of the referee via this API. This will grant the referee their reward, or will inform them on how to obtain one if further action is required (e.g. making a purchase).

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

Version

Allowed:
Body Params

Details of the new customer who has been referred

integer
required

Id representing the referrer returned by a successful name search

string
required

Token representing the referrer returned by a successful name search

customer
required

Information about the referee to register and give a reward

request
required

Information about the request

Responses

400

The request contains errors

403

Returned when the integration for this merchant is not enabled

404

Returned when the referrer is not found

500

Internal server error, unable to complete the request

Updated 10 months ago

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

Updated 10 months ago