v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Referrals (Lookup)

Retrieves the referee details of a customer (referral).

get/customers/lookup/referrals

Query parameters

source'FACEBOOK' | 'WEB_ENGAGE' | 'WECHAT' | 'INSTORE' | 'MARTJACK' | 'TMALL' | 'TAOBAO' | 'JD' | 'ECOMMERCE' | 'WEBSITE' | 'LINE' | 'MOBILE_APP' required

Source in which the identifier is available.

accountIdstring

Account ID for sources with multiple accounts.

identifierName'mobile' | 'email' | 'externalId' | 'cardExternalId' | 'cardNumber' required

Customer identifier to fetch referral details.

identifierValuestring required

Identifier value as per the specified identifierName.

campaignTokenstring required

Unique token generated for the referral campaign.

Response

200