Loading
Prepare for Email to Become the Default Login ExperienceRead More
Referral Marketing
Advocate Enrollment by Using Business API

You are here:

  1. Salesforce Help
  2. Docs
  3. Referral Marketing

Advocate Enrollment by Using Business API

Use the Referral Advocate Enrollments Business API to enroll existing and new customers in referral promotions. Integrate the API with any site or external system where customers can join the referral promotion. For example, you can integrate the API with your brand’s ecommerce site or POS system.

Required Editions

Available in: Lightning Experience
Available in: Enterprise, Performance, Unlimited, and Developer Editions with Referral Marketing

Learn About the Advocate Enrollment Business API

To learn about the Advocate Enrollment Business API’s resource, request body, and response body, see Referral Advocate Enrollments in the Referral Marketing Developer Guide.

Enroll Existing Referral Program Advocates

To enroll an advocate of your referral program in a promotion, run the API with the membership number of the advocate. The advocate’s membership number is stored in the Membership Number field on the advocate’s Loyalty Program Member record.

Enroll Existing Customers

To enroll an existing customer who isn’t an advocate of your referral program in a promotion, run the API with the ID of the customer’s contact record.

Enroll New Customers

To enroll a person who hasn’t signed up with the brand and who doesn’t have a contact record in the org, run the API with the person’s contact details.

Tip
Tip For new customers who are joining as advocates, you can also specify a unique membership number. Use the membershipNumber field in the API request body to specify a unique membership number that you want to provide to the advocate or that the advocate has specified. If you don’t specify a membership number, an eight-character membership number is automatically generated for the advocate.
 
Loading
Salesforce Help | Article