Referral Marketing Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Referral Marketing
Referral Marketing Standard Objects
Referral Marketing Fields on Standard Objects
Referral Marketing Associated Objects
Referral Marketing Business APIs
REST Reference
Resources
Referral Advocate Enrollments
Redeem Voucher
Referral Event
Referral Advocate Profile
Request Bodies
Response Bodies
Referral Marketing Standard Invocable Actions
Referral Marketing Metadata API Types
Referral Mobile SDK
PDF

Referral Advocate Profile

View the profile of a referral program advocate.
Resource
/referral-programs/advocate-profile
Available version
62.0
HTTP methods
POST
JSON example
{
   "contactId" : "0lm121212121ASD",
   "programName" : "0op121217777",
   "shouldGetReferralSummary" : "true",
   "shouldGetReferrals" : "true"
}
JSON example
{
   "memberId" : "0qw121212121AQD",
   "promotionId" : "0gh123238467AJH"
}
JSON example
{
   "membershipNumber" : "mem1",
   "programName" : "RP1"
}
JSON example
{
   "membershipNumber" : "mem1",
   "programId" : "0opqwqwqwq1212AFG",
   "promotionCode" "SMRBNZ"
}
JSON example
{
   "contactDetails" : {
            "email" : "aman.bindal@sf.com",
            "lastName" : "Bindal"
    },
   "promotionCode" : "SMRBNZ",
   "programName" : "0op121217777"
}
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 Output Representation