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 Event

Output representation of the request to create a referral event record.

JSON example

1{
2   "contactIds":[
3      "0031Q00002kCusB"
4   ],
5   "referralIds":[
6      "0wi1Q000000ljna"
7   ],
8   "referralStage":"Friend Completes First Purchase",
9   "transactionJournalIds":[
10      "0lV1Q0000019gJg",
11      "0lV1Q0000019gJh"
12   ],
13   "voucherId":"0kD1Q000000keXVUAY",
14"voucherList": [
15 {
16 "effectiveDate": "2024-06-14",
17 "expirationDate": "2025-04-14",
18 "transactionJournalId": "0lV1Q0000019gJg",
19 "voucherCode": "SW504FF7",
20 "voucherDefinition": "Voucher2",
21 "voucherId": "0kD1Q000000keXVUAY"
22 },
23 {
24 "effectiveDate": "2024-06-14",
25 "expirationDate": "2025-04-14",
26 "transactionJournalId": "0lV1Q0000019gJh",
27 "voucherCode": "IKWX6D5D",
28 "voucherDefinition": "Voucher2",
29 "voucherId": "0kDxx00000002l0EAA"
30 }
31 ]
32 }

Property Name	Type	Description	Filter Group and Version	Available Version
`contactIds`	String[]	IDs of the contact records created or used to identify the referred friends.	Small, 59.0	59.0
`referralIds`	String[]	IDs of the referral records created or used to identify the referrals.	Small, 59.0	59.0
`referralStage`	String	Promotion stage to which the referral belongs.	Small, 59.0	59.0
`transactionJournalIds`	String[]	IDs of the transaction journal records created for the events.	Small, 59.0	59.0
`voucherId`	String	ID of the voucher belonging to the referred friend.	Small, 59.0	59.0
voucherList	String[]	The details of the voucher records that is created for the referral event.	Small, 62.0	62.0

Referral Marketing Developer Guide

Referral Event