This API allows you to refer someone with the referral code of a specific campaign to a customer (auto-generated referral code).
It is important to understand the following terminologies that you may come across while using the customer/APIs.
referral_code
Unique code generated for the referrer for a specific campaign. Each referral campaign generates a unique code for each customer.
invitee
A person who was invited by the referrer.
referees
Customers from the invitee list who turned up to the stores and made either transactions or registration
incentives
Rewards received by the referral for successful referees of the campaign. Currently, only coupons are issued as incentives.
scope
The channel through which the referral was made. Currently, the referrals are supported only through email and mobile numbers. Scopes are used as name-value pairs, the value could be referees, invitees, or incentives as per the context.
The token of the referral campaign to which you are referring. You can get this token from the campaign home page under the referral campaign name.
--- type*
String
Type of referral. Supported values: MOBILE and EMAIL.
- referral
Array
An array of referral objects that contains the details of the individual to whom you are referring (invitee).
id*
String
User ID of the individual if any. Else, you can leave this field empty.
invited_on*
String
A timestamp in ISO 8601 format indicating when the referral was invited along with the referral code. For example, 20240910T16:35:52.pV7BF, where pV7BF is the referral code.
