Referral Event Input

Input representation of the request to create a referral event.

JSON example

1{
2   "referralCode":"referralCode-promotionCode",
3   "contactId":"003xx000004WkhEAAS",
4   "firstName":"Michael",
5   "lastName":"Clare",
6   "email":"mclare@salesforce.com",
7   "joiningDate":"2021-04-13T00:00:00",
8   "eventType":"Product Purchase",
9   "productId":"01txx0000006iGyAAI",
10   "purchaseAmount":40000,
11   "purchaseQuantity":34,
12   "additionalAttributes":{
13      "attributes":{
14         "phoneNumber":"1234567890",
15         "emailOptOut":true
16      }
17   },
18   "transactionJournalAdditionalAttributes":{
19      
20   },
21   "orderReferenceId":"003xx00000000fxEAA"
22}

Properties

Name	Type	Description	Required or Optional	Available Version
`contactId`	String	Contact ID of the referred friend.	Optional Required if the referral record exists.	59.0
`email`	String	Email address of the referred friend.	Optional Required only if the contact ID of the referred friend doesn’t exist.	59.0
`eventType`	String	Type of event completed by the referred friend or advocate. Possible values are: `Enrollment` `Purchase` `Refer`	Required	59.0
`firstName`	String	First name of the referred friend.	Optional Required only if the contact ID of the referred friend doesn’t exist.	59.0
`joiningDate`	String	Date the referred friend joined as a new customer.	Required	59.0
`lastName`	String	Family name of the referred friend.	Optional Required only if the contact ID of the referred friend doesn’t exist.	59.0
`orderReferenceId`	String	External purchase order ID. This field is applicable only when the event type is `Purchase`.	Optional	59.0
`productId`	String	ID of the product purchased by the referral. This field is applicable only when the event type is `Purchase`.	Optional	59.0
`purchaseAmount`	Double	Price of the product purchased by the referred friend. This field is applicable only when the event type is `Purchase`.	Optional	59.0
`purchaseQuantity`	Integer	Quantity purchased by the referred friend. This field is applicable only when the event type is `Purchase`.	Optional	59.0
`referralAdditionalAttributes`	Map<String, String>	Key value pairs for additional information about the referred friend.	Optional	59.0
`referralCode`	String	Referral code used by the referred friend to sign up or make a purchase. It’s a combination of the referral code and promotion code in the format, `referralCode-promotionCode`.	Required	59.0
`transactionJournalAdditionalAttributes`	Map<String, String>	Additional details of the transaction journal that is created for the event.	Optional	59.0

Referral Marketing Developer Guide

Referral Event Input