Referral Marketing Developer Guide

Introduction to Referral Marketing
Referral Marketing Standard Objects
Referral Marketing Associated Objects
Referral Marketing Business APIs
REST Reference
Resources
Referral Advocate Enrollments
Redeem Voucher
Referral Event
Request Bodies
Response Bodies
Referral Marketing Metadata API Types
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Referral Event

Create referral event records when an advocate refers a friend, or when referred friends sign up or make a purchase.
Resource
Example
Available version
59.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
JSON example
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
Response body for POST
Referral Event Output