Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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

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}

Properties

Name	Type	Description	Required or Optional	Available Version
`contactDetails`	Contact Details []	The details of that are required to uniquely identify an advocate's Contact record.	Small, 62.0	62.0
`contactId`	String	The ID of the advocate's Contact record.	Small, 62.0	62.0
`memberId`	String	The ID of the advocate's Loyalty Program Member record.	Small, 62.0	62.0
`membershipNumber`	String	The unique referral program membership number of the advocate.	Small, 62.0	62.0
`programId`	String	The ID of the referral program that the advocate is a part of.	Small, 62.0	62.0
`programName`	String	The name of the referral program that the advocate is a part of.	Small, 62.0	62.0
`promotionCode`	String	The code of the promotion for which you want to view the advocate's referral details.	Small, 62.0	62.0
`promotionId`	String	The ID of the promotion for which you want to view the advocate's referral details.	Small, 62.0	62.0
`shouldGetReferralSummary`	Boolean	Indicates whether the response should contain the details of the advocates in progress and successful referrals.	Small, 62.0	62.0
`shouldGetReferrals`	Boolean	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.	Small, 62.0	62.0

Response body for POST: Referral Advocate Profile

Referral Marketing Developer Guide

Referral Advocate Profile (POST)