Introduction

The Referred Friend API allows you to manage referred friends in your referral program on your Wix site.

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 Referred Friend 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 person who clicks on a referral URL shared by a referring customer.
• Referring Customer: A site member who shares a referral URL with potential new customers.
• Referral Code: A unique code assigned to a referring customer.
• Referral Program: A feature that allows your site members to refer friends to your business by sharing referral URLs. You have the option to reward both the customer doing the referring and the friend being referred.
• Status: The current state of a referred friend in the referral program (for example, SIGN_UP_COMPLETED, ACTIONS_COMPLETED).