> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# CreateReferredFriend

# Package: referralProgram

# Namespace: ReferredFriends

# Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referred-friends/create-referred-friend.md

## Permission Scopes:
Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS

## Introduction

Creates a new referred friend or returns an existing entity if it already exists.

This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md#site-members).

A referral code must be provided either in the request or via scope.

The member must be eligible to become a referred friend.

---

## REST API

### Schema

```
 Method: createReferredFriend
 Description: Creates a new referred friend or returns an existing entity if it already exists.  This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md#site-members).  A referral code must be provided either in the request or via scope.  The member must be eligible to become a referred friend.
 URL: https://www.wixapis.com/v1/referred-friends
 Method: POST
 Method parameters:
   param name: referralCode | type: referralCode | description: Referral code for the referred friend. 
 Return type: CreateReferredFriendResponse
  - name: referredFriend | type: ReferredFriend | description: Created referred friend. 
     - name: id | type: string | description: GUID of the referred friend. 
     - name: contactId | type: string | description: Contact GUID of the referred friend. 
     - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend. 
     - name: status | type: Status | description: Status of the referred friend. 
         - enum:
         -     UNKNOWN: Unknown status.
         -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
         -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend. 
     - name: createdDate | type: string | description: Date and time the referred friend was created. 
     - name: updatedDate | type: string | description: Date and time the referred friend was last updated. 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_NOT_ELIGIBLE | Description: The member isn't eligible to become a referred friend. This can happen if another customer has already referred the member or if the member is already a referring customer.


```

### Examples

### Create Referred Friend
```curl
curl -X POST \
  'https://www.wixapis.com/referral_friends/v1/referred-friends' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
        "referralCode": "9zb9JvjwrvQF"
      }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.referralProgram.ReferredFriends.createReferredFriend(options)
 Description: Creates a new referred friend or returns an existing entity if it already exists.  This method must be called with a [member identity](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md#site-members).  A referral code must be provided either in the request or via scope.  The member must be eligible to become a referred friend.
 Method parameters:
   param name: options | type: CreateReferredFriendOptions  none 
        - name: referralCode | type: string | description: Referral code for the referred friend. 
 Return type: PROMISE<CreateReferredFriendResponse>
  - name: referredFriend | type: ReferredFriend | description: Created referred friend. 
     - name: _id | type: string | description: GUID of the referred friend. 
     - name: contactId | type: string | description: Contact GUID of the referred friend. 
     - name: referringCustomerId | type: string | description: GUID of the customer who referred this friend. 
     - name: status | type: Status | description: Status of the referred friend. 
         - enum:
         -     UNKNOWN: Unknown status.
         -     SIGN_UP_COMPLETED: Initial status when the referred friend joins the site as a member.
         -     ACTIONS_COMPLETED: Status after the referred friend completes a specific action, such as making a purchase.
     - name: revision | type: string | description: Revision number, which increments by 1 each time the referred friend is updated. To prevent conflicting changes, the current revision must be passed when updating the referred friend. 
     - name: _createdDate | type: Date | description: Date and time the referred friend was created. 
     - name: _updatedDate | type: Date | description: Date and time the referred friend was last updated. 

 Possible Errors:
   HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: MEMBER_NOT_ELIGIBLE | Description: The member isn't eligible to become a referred friend. This can happen if another customer has already referred the member or if the member is already a referring customer.


```

### Examples

### createReferredFriend
```javascript
import { friends } from '@wix/referral';

async function createReferredFriend(options) {
  const response = await friends.createReferredFriend(options);
};
```

### createReferredFriend (self-hosted)
Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { friends } from '@wix/referral';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { friends },
  // Include the auth strategy and host as relevant
});


async function createReferredFriend(options) {
  const response = await myWixClient.friends.createReferredFriend(options);
};
```

---