Skip to main content
POST
Enrol referrer

Path Parameters

version
enum<string>
required

Version

Available options:
v2,
v1
Pattern: v2|v1

Body

application/json

Details of the customer to enrol

customer
Customer · object
required

Information about the referrer to enrol

request
Request · object
required

Information about the request

order
Order · object

Information about the order (used for recording order events AND segmentation)

address
Address · object

Information about the address of the customer, for segmentation

Response

Returned when successful

offer
Description of the offer and rewards. · object
nameShare
Name Share information: · object

Details about NameShare, including the name someone can search for and their referral code if available.

Last modified on July 13, 2026