Newer Version Available

This content describes an older version of this product. View Latest

Referral Advocate Profile

Represents the output for Referral Advocate Profile API.
JSON Example
1{
2    "enrolledPromotionsList" : [
3        {
4            
5            "programId": "0lx1234567ABC",
6            "programName": "RP1",
7            "memberId" : "0qw12121212121ASD",
8            "membershipNumber" : "mem1",
9            "promotionName" : "Summer bonanza",
10            "promotionCode" : "SMRBNZ",
11            "promotionDescription" : "This is a summer promo",
12            "promotionId" : "0op84848484848ASD",
13            "promotionStartDate" : "2024-01-03T00:00:00",
14            "promotionEndDate" : "2025-01-04T00:00:00",
15            "promotionPageUrl" : "https://www.nike.com",
16            "promotionImageUrl" : "https://www.nike.com/098wqwqwq-898q9ww",
17            "isMemberPromotionEnrollementActive" : true,
18            "memberReferralCode" : "GTRFDSX09",
19            "memberReferralUrl" : "https://www.nike.com/GTRFDSX09-SMRBNZ",
20            "memberPromotionSummary" : {
21                "referralCount" : 6,
22                "referralsOnStageFourCount" : 2,
23                "referralsOnStageFiveCount", 1,
24                "vouchersIssuedCount" : 3
25            }
26        }
27    ],
28    "eligiblePromotionsList" : [
29        {
30            
31            "programId": "0lx1234567ABC",
32            "programName": "RP1",
33            "memberId" : "0qw12121212121ASD",
34            "membershipNumber" : "mem1",
35            "promotionName" : "Winter bonanza",
36            "promotionCode" : "WNTRBNZ",
37            "promotionDescription" : "This is a winter promo",
38            "promotionId" : "0op8484848467ASF",
39            "promotionStartDate" : "2024-01-03T00:00:00",
40            "promotionEndDate" : "2025-01-04T00:00:00",
41            "promotionPageUrl" : "https://www.adidas.com",
42            "promotionImageUrl" : "https://www.adidas.com/098wqwqwq-898q9ww",
43            "isMemberPromotionEnrollementActive" : false
44        }
45    ],
46    "programSummary" : {
47       "referralCount" : 14,
48        "referralsOnStageFourCount" : 6,
49        "referralsOnStageFiveCount", 3,
50        "vouchersIssuedCount" : 8
51    },
52    "referralSummaryList" : [
53        {
54           "referredPartyName":"Michael Clare",
55           "referralId":"0lx567687878GVBH",
56           "promotionId":"0opujh343jdbcGVF",
57           "promotionName":"Summer Bonanza",
58           "referralLastModifiedDate":"2024-06-17T00:00:00",
59           "promotionStageName":"Advocate Refers Friend",
60           "contactId" : "0c300000000000001A",
61           "referralCreationDate" : "2024-06-12T00:00:00"
62        }
63    ]
64}
Table 1. Properties
Property Name Type Description Filter Group and Version Available Version
eligiblePromotionList Referral Promotion[] The list of promotions that the advocate is eligible for. Small, 62.0 62.0
enrolledPromotionList Referral Promotion [] The list of promotions that the advocate is enrolled in. Small, 62.0 62.0
programSummary Referral Statistics [] referral statistics in thw whole program for advocate Small, 62.0 62.0
referralSummaryList Referral Info [] The list of referrals that the advocate has submitted. Small, 62.0 62.0