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 }

Properties

contactIds

Type: String[]

Description: IDs of the contact records created or used to identify the referred friends.

Filter Group and Version: Small, 59.0

Available Version: 59.0

referralIds

Type: String[]

Description: IDs of the referral records created or used to identify the referrals.

Filter Group and Version: Small, 59.0

Available Version: 59.0

referralStage

Type: String

Description: Promotion stage to which the referral belongs.

Filter Group and Version: Small, 59.0

Available Version: 59.0

transactionJournalIds

Type: String[]

Description: IDs of the transaction journal records created for the events.

Filter Group and Version: Small, 59.0

Available Version: 59.0

voucherId

Type: String

Description: ID of the voucher belonging to the referred friend.

Filter Group and Version: Small, 59.0

Available Version: 59.0

voucherList

Type: String[]

Description: The details of the voucher records that is created for the referral event.

Filter Group and Version: Small, 62.0

Available Version: 62.0