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
Referral Marketing Standard Invocable Actions
Create Referral Event
Referral Marketing Metadata API Types
Referral Mobile SDK
PDF

Create Referral Event

Create referral event records when an advocate refers a friend, or when referred friends sign up or make a purchase.

This action is available in API version 60.0 and later for users with the Referral Marketing license.

Supported REST HTTP Methods

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

Inputs

Input Details
activityDateTime
Type
DateTime
Description
Required. The date and time when the referral event took place.
eventType
Type
String
Description
Required. The type of event that the referral completed. Possible values are:
  • Refer
  • Enrollment
  • Purchase
externalReferenceNumber
Type
String
Description
The number generated by an external system for the referral event.
referralCode
Type
String
Description
Required. The referral code used by a referral to sign up as a customer, or to make a purchase. The referral code is a combination of the advocate’s referral code and the promotion code separated by a hyphen.
referralContactId
Type
String
Description
The contact ID of the referral who signed up to be a customer, or to make a purchase.
referralEmail
Type
String
Description
The email address of the referral who has signed up to be a customer, or to make a purchase.
referralFirstName
Type
String
Description
The first name of the referral who signed up to be a customer, or to make a purchase.
referralLastName
Type
String
Description
The last name of the referral who signed up to be a customer, or to make a purchase.
productId
Type
String
Description
The ID of the product that the referral purchased.
purchaseAmount
Type
String
Description
The amount the referral spent to purchase one or more units of a product.
purchaseQuantity
Type
String
Description
The number of units that the referral purchased of a product.

Outputs

Output Details
contactId
Type
String
Description
The ID of the contact record that’s either created for the referral or that uniquely identifies the referral.
referralId
Type
String
Description
The ID of the referral record of the person who was referred, or whose referral event is processed.
referralStage
Type
String
Description
The current stage of the referral promotion for a referral. Possible values are:
  • Promotion Launched
  • Advocate Joins Promotion
  • Advocate Refers Friend
  • Friend Signs Up
  • Friend Completes First Purchase
transactionJournalIds
Type
String
Description
The comma separate list of transaction journal IDs created to process the referral event.
voucherId
Type
String
Description
The ID of the voucher issued to either the referral signing up or to the advocate after the referral completes a purchase.

Example

Sample Request

{
   "inputs":[
      {
         "referralCode":"referralCode-promotionCode",
         "referralContactId":"003xx000004WkhEAAS",
         "referralFirstName":"Michael",
         "referralLastName":"Clare",
         "referralEmail":"mclare@salesforce.com",
         "activityDateTime":"2021-04-13T00:00:00",
         "eventType":"Purchase",
         "productId":"01txx0000006iGyAAI",
         "purchaseAmount":40000,
         "purchaseQuantity":34,
         "externalReferenceNumber":"003xx00000000fxEAA"
      }
   ]
}

Sample Response

[
   {
      "actionName":"processReferralEvent",
      "errors":null,
      "isSuccess":true,
      "outputValues":{
         "contactId":"003RM000008O9ZT",
         "transactionJournalIds":[
            "0lVRM0000002qtT",
            "0lVRM0000002qtU"
         ],
         "referralId":"0wiRM0000004CPf",
         "referralStage":"Friend Completes First Purchase",
         "voucherId":"0kDRM0000004DZl2AM"
      },
      "version":1
   }
]