Referral Event (POST)

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

To use this resource, your org must have person accounts enabled.

Resource Example:

59.0

No

POST

Here’s an example of a payload for an event where the existing member refers his friend, Michael Clare.

Here’s an example of a payload to know which channel did the referral come from.

Here’s an example of a payload for an event where Michael Clare signs up for the referral program.

Here’s an example of a payload for an event where Michael Clare purchases a product.

Here’s an example of a payload for an event where the existing member refers multiple friends.

The date and time when the referral event took place.

Type: String. Optional. This field is required only if the joining date isn’t specified in the request. Available in version 59.0.

Contact ID of the referred friend.

Type: String. Optional. Required if the referral record exists. Available in version 59.0.

Email address of the referred friend.

Type: String. Optional. Required only if the contact ID of the referred friend doesn’t exist. Available in version 59.0.

Type of event completed by the referred friend or advocate.

Possible values are:

  • Enrollment
  • Purchase
  • Refer

Type: String. Required. Available in version 59.0.

First name of the referred friend.

Type: String. Optional. Required only if the contact ID of the referred friend doesn’t exist. Available in version 59.0.

Date the referred friend joined as a new customer.

This field has been deprecated. In API version 59.0 and later, use the new activityDateTime field.

Type: String. Optional. This field is required only if the activity date and time isn’t specified in the request. Available in version 59.0.

Family name of the referred friend.

Type: String. Optional. Required only if the contact ID of the referred friend doesn’t exist. Available in version 59.0.

Mobile phone of the referral.

Type: String. Optional. Available in version 68.0.

Indicates whether the new customer has opted in to receive WhatsApp messages from the company.

Type: Boolean. Optional. Available in version 62.0.

External purchase order ID.

This field is applicable only when the event type is Purchase.

Type: String. Optional. Available in version 59.0.

ID of the product purchased by the referral.

This field is applicable only when the event type is Purchase.

Type: String. Optional. Available in version 59.0.

Price of the product purchased by the referred friend.

This field is applicable only when the event type is Purchase.

Type: Double. Optional. Available in version 59.0.

Quantity purchased by the referred friend.

This field is applicable only when the event type is Purchase.

Type: Integer. Optional. Available in version 59.0.

Key value pairs for additional information about the referred friend.

Type: Map<String, String>. Optional. Available in version 59.0.

Channels such as email and social media that are used to refer a friend.

Type: String. Optional. Available in version 62.0.

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.

Type: String. Required. Available in version 59.0.

The email addresses of the referral friends.

Type: String[]. Optional. Available in version 59.0.

The mobile phone numbers of the referral friends.

Type: String[]. Optional. Available in version 68.0.

The event type to consider based on the stage of the referral promotion.

Type: String. Optional. Available in version 62.0.

The activity for which the referred members are rewarded.

Type: String. Optional. Available in version 62.0.

Additional details of the transaction journal that is created for the event.

Type: Map<String, String>. Optional. Available in version 59.0.

Locale for contact for WhatsApp distribution channel.

Type: String. Optional. Available in version 62.0.

Contact field used for Locale WhatsApp distribution channel.

Type: String. Optional. Available in version 62.0.

Referral Event