Skip to main content
POST
Register referee

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 | null
content
object
status
string
Last modified on July 13, 2026