> 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

# AddUserFavorite

# Package: dashboard

# Namespace: DashboardFavoritesService

# Method link: https://dev.wix.com/docs/api-reference/business-management/dashboard/dashboard-favorite-list/add-user-favorite.md

## Permission Scopes:
Manage Dashboard: SCOPE.DC-OS.MANAGE_DASHBOARD

## Introduction

Adds a page to the current Wix user's list of favorite dashboard pages. If the Wix user doesn't have a list, the method creates a new list and adds the favorite page to it.

---

## REST API

### Schema

```
 Method: addUserFavorite
 Description: Adds a page to the current Wix user's list of favorite dashboard pages. If the Wix user doesn't have a list, the method creates a new list and adds the favorite page to it.
 URL: https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  favorite
 Method parameters: 
   param name: favorite | type: Favorite   | required: true
        - name: id | type: string | description: Favorite GUID. Automatically generated by Wix. 
        - name: pageId | type: string | description: GUID of the page added to the list. 
        - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier. 
        - name: title | type: string | description: Custom title displayed in the list of favorite pages. 
 Return type: AddUserFavoriteResponse
  - name: favoriteList | type: DashboardFavoriteList | description: Updated dashboard favorite list. 
     - name: id | type: string | description: Dashboard favorite list GUID. Automatically generated by Wix. 
     - name: revision | type: string | description: Revision number. Increments automatically by 1 whenever the list is successfully updated. To prevent conflicting changes, pass the current revision number when updating the list. 
     - name: createdDate | type: string | description: Date and time the dashboard favorite list was created. 
     - name: updatedDate | type: string | description: Date and time the dashboard favorite list was last updated. 
     - name: favorites | type: array<Favorite> | description: List of favorite dashboard pages. 
        - name: id | type: string | description: Favorite GUID. Automatically generated by Wix. 
        - name: pageId | type: string | description: GUID of the page added to the list. 
        - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier. 
        - name: title | type: string | description: Custom title displayed in the list of favorite pages. 


```

### Examples

### Add Page to User Favorite List
```curl
curl -X POST \
  'https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite' \
  -H 'Authorization: <AUTH>' \
  -H 'Content-Type: application/json' \
  -d '{
        "favorite": {
            "pageId": "3893d33b-24a1-474b-80b0-dd7c32e20bfb",
            "title": "New Favorite Page"
        }
  }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.dashboard.DashboardFavoritesService.addUserFavorite(favorite)
 Description: Adds a page to the current Wix user's list of favorite dashboard pages. If the Wix user doesn't have a list, the method creates a new list and adds the favorite page to it.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  favorite
 Method parameters: 
   param name: favorite | type: Favorite   | required: true
        - name: _id | type: string | description: Favorite GUID. Automatically generated by Wix. 
        - name: pageId | type: string | description: GUID of the page added to the list. 
        - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier. 
        - name: title | type: string | description: Custom title displayed in the list of favorite pages. 
 Return type: PROMISE<AddUserFavoriteResponse>
  - name: favoriteList | type: DashboardFavoriteList | description: Updated dashboard favorite list. 
     - name: _id | type: string | description: Dashboard favorite list GUID. Automatically generated by Wix. 
     - name: revision | type: string | description: Revision number. Increments automatically by 1 whenever the list is successfully updated. To prevent conflicting changes, pass the current revision number when updating the list. 
     - name: _createdDate | type: Date | description: Date and time the dashboard favorite list was created. 
     - name: _updatedDate | type: Date | description: Date and time the dashboard favorite list was last updated. 
     - name: favorites | type: array<Favorite> | description: List of favorite dashboard pages. 
        - name: _id | type: string | description: Favorite GUID. Automatically generated by Wix. 
        - name: pageId | type: string | description: GUID of the page added to the list. 
        - name: relativeUrl | type: string | description: Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier. 
        - name: title | type: string | description: Custom title displayed in the list of favorite pages. 


```

### Examples

### addUserFavorite
```javascript
import { favoriteList } from '@wix/dashboard-management';

async function addUserFavorite(favorite) {
  const response = await favoriteList.addUserFavorite(favorite);
};
```

### addUserFavorite (with elevated permissions)
```javascript
import { favoriteList } from '@wix/dashboard-management';
import { auth } from '@wix/essentials';

async function myAddUserFavoriteMethod(favorite) {
  const elevatedAddUserFavorite = auth.elevate(favoriteList.addUserFavorite);
  const response = await elevatedAddUserFavorite(favorite);
}
```

### addUserFavorite (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 { favoriteList } from '@wix/dashboard-management';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

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


async function addUserFavorite(favorite) {
  const response = await myWixClient.favoriteList.addUserFavorite(favorite);
};
```

---