Referral Advocate Profile (POST)

View the profile of a referral program advocate.

Resource 

1/referral-programs/advocate-profile

Available Version 

62.0

HTTP Methods 

POST

Request Body for POST 

JSON Example 

1{
2   "contactId" : "0lm121212121ASD",
3   "programName" : "0op121217777",
4   "shouldGetReferralSummary" : "true",
5   "shouldGetReferrals" : "true"
6}

JSON Example 

1{
2   "memberId" : "0qw121212121AQD",
3   "promotionId" : "0gh123238467AJH"
4}

JSON Example 

1{
2   "membershipNumber" : "mem1",
3   "programName" : "RP1"
4}

JSON Example 

1{
2   "membershipNumber" : "mem1",
3   "programId" : "0opqwqwqwq1212AFG",
4   "promotionCode" "SMRBNZ"
5}

JSON Example 

1{
2   "contactDetails" : {
3            "email" : "aman.bindal@sf.com",
4            "lastName" : "Bindal"
5    },
6   "promotionCode" : "SMRBNZ",
7   "programName" : "0op121217777"
8}

Request Body Properties 

contactDetails 

The details of that are required to uniquely identify an advocate’s Contact record.

Type: Contact Details []. Small, 62.0. Available in version 62.0.

contactId 

The ID of the advocate’s Contact record.

Type: String. Small, 62.0. Available in version 62.0.

memberId 

The ID of the advocate’s Loyalty Program Member record.

Type: String. Small, 62.0. Available in version 62.0.

membershipNumber 

The unique referral program membership number of the advocate.

Type: String. Small, 62.0. Available in version 62.0.

programId 

The ID of the referral program that the advocate is a part of.

Type: String. Small, 62.0. Available in version 62.0.

programName 

The name of the referral program that the advocate is a part of.

Type: String. Small, 62.0. Available in version 62.0.

promotionCode 

The code of the promotion for which you want to view the advocate’s referral details.

Type: String. Small, 62.0. Available in version 62.0.

promotionId 

The ID of the promotion for which you want to view the advocate’s referral details.

Type: String. Small, 62.0. Available in version 62.0.

shouldGetReferralSummary 

Indicates whether the response should contain the details of the advocates in progress and successful referrals.

Type: Boolean. Small, 62.0. Available in version 62.0.

shouldGetReferrals 

True, when you want detailed referral information of all your referrals from promotion if promotion ID is mentioned or program if promotion ID is not mentioned.

Type: Boolean. Small, 62.0. Available in version 62.0.

Response Body for POST 

Referral Advocate Profile