Introduction

The Referred Friend API allows you to manage referred friends in your referral program on your Wix site. With this API, you can create, retrieve, update, and delete referred friends, as well as query for specific referred friends based on various criteria.

With the Referred Friend API, you can:

• Create a referred friend to add new participants to your referral program.
• Get a referred friend to retrieve details about a specific referred friend.
• Get a referred friend by contact ID to find a referred friend using their contact information.
• Update a referred friend to modify information about an existing referred friend.
• Delete a referred friend to remove a referred friend from your program.
• Query referred friends to search for and retrieve multiple referred friends based on specific criteria.

Before you begin

It's important to note the following points before starting to code:

• The Referral Program API requires a Business or higher plan for Wix Editor, or a Plus or higher plan for Wix Studio.
• You must have at least one of these apps installed: Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans, or the new Wix Restaurants ordering app.

Terminology

• Referred Friend: A new customer who was referred to your site or business by an existing customer.
• Referring Customer: An existing customer who refers others to your site or business.
• Referral Code: A unique code assigned to a referring customer, used to track referrals.
• Referral Program: A marketing strategy that incentivizes existing customers to refer new customers.
• Status: The current state of a referred friend in the referral program (for example, SIGN_UP_COMPLETED, ACTIONS_COMPLETED).

Setup

To use the Friends API, install the @wix/referral package using npm or Yarn:

npm install @wix/referral

or

yarn add @wix/referral

Then import { friends } from @wix/referral:

import { friends } from "@wix/referral";