Referral Marketing Developer Guide

Introduction to Referral Marketing
Standard Objects
Referral Marketing Fields on Standard Objects
Associated Objects
Referral Marketing Business APIs
Referral Marketing Standard Invocable Actions
Referral Marketing Metadata API Types
B2B Referral Management
B2B Referral Management Standard Invocable Actions
Advocate Enrollment
Referral Event
B2B Referral Management Metadata API Types
Referral Mobile SDK
PDF

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.

Advocate Enrollment

Enroll an existing or new customer as an advocate of a referral promotion.

This action is available in API version 64.0 and later.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/enrollAdvocateB2bReferralProm
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer Token

Inputs

Input Details
program​Name
Type
String
Description
Required. Loyalty program name associated with the promotion.
promotion​Id
Type
String
Description
Promotion ID of the promotion. The account is enrolled as an advocate for this promotion.
promotion​Code
Type
String
Description
Promotion code used to enroll accounts as an advocate in this promotion.
account​Id
Type
String
Description
Account ID of the account that is going to be enrolled as an advocate.
member​Status
Type
String
Description
Status of the new advocate after enrollment is completed.
membership​Number
Type
String
Description
Membership number of the account that is enrolled as a loyalty program member.
referral​First​Name
Type
String
Description
The first name of the referral who signed up to be a customer, or to make a purchase.
enrollment​Channel
Type
String
Description
Channel used by the advocate to join the referral program.

Outputs

Output Details
program​Name
Type
String
Description
Required. Loyalty program name associated with the promotion.
promotion​Code
Type
String
Description
Promotion code used to enroll accounts as an advocate in this promotion.
member​Id
Type
String
Description
Promotion code used to enroll accounts as an advocate in this promotion.
account​Id
Type
String
Description
Account ID of the account that is going to be enrolled as an advocate.
membership​Number
Type
String
Description
Membership number of the account that is enrolled as a loyalty program member.
transaction​Journal​Ids
Type
String
Description
The comma separate list of transaction journal IDs created for target member enrollment.

Example

Sample Request

1{
2   "inputs":[
3      {
4         "programName": "demo",
5         "promotionId": "0c8xx00000001NVAAY",
6         "accountId": "001xx000003Ge63AAC"
7 }
8 ]
9}

Sample Response

1
2{
3"actionName": "enrollAdvocateB2bReferralProm",
4"errors": null,
5"invocationId": null,
6"isSuccess": true,
7"outcome": null,
8"outputValues": {
9"membershipNumber": "BTMADV1",
10"accountId": "001xx000003Ge63AAC",
11"programName": "RP01",
12"referralCode": "PN4SCF73-RPT01",
13"promotionCode": "RPT01",
14"transactionJournals": [
15"0lVxx00000001SL"
16],
17"memberId": "0lMxx00000000Mb"
18},
19"sortOrder": -1,
20"version": 1
21}
22]