Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

favorite

Favorite

Adds a page to the current user’s list of favorite dashboard pages. If the user does not have a list, the endpoint creates a new list and adds the favorite page to it.

import { favoriteList } from 'wix-dashboard-management.v2';

async function addUserFavorite(favorite) {
  try {
    const result = await favoriteList.addUserFavorite(favorite);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


addUserFavorite example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedAddUserFavorite = elevate(favoriteList.addUserFavorite);

export const addUserFavorite = webMethod(
  Permissions.Anyone,
  async (favorite) => {
    try {
      const result = await elevatedAddUserFavorite(favorite);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


addUserFavorite example for exporting from backend code

addUserFavorite

AddUserFavoriteResponse

favoriteList

DashboardFavoriteList

Creates a list of favorite dashboard pages for the current user. A user can only have one such list.

> **Note:**
> When first calling this endpoint, you can create a list that contains one or more favorite dashboard pages. However, if a list already exists for that user, calling this endpoint generates an error.

import { favoriteList } from 'wix-dashboard-management.v2';

async function createUserFavoriteList(favoriteList) {
  try {
    const result = await favoriteList.createUserFavoriteList(favoriteList);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


createUserFavoriteList example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedCreateUserFavoriteList = elevate(favoriteList.createUserFavoriteList);

export const createUserFavoriteList = webMethod(
  Permissions.Anyone,
  async (favoriteList) => {
    try {
      const result = await elevatedCreateUserFavoriteList(favoriteList);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


createUserFavoriteList example for exporting from backend code

createUserFavoriteList

ID of the favorite page to delete from the list.

favoriteId

string

Deletes the specified favorite page from the current user's list of favorite dashboard pages. If no favorites remain in the list, it is deleted.

import { favoriteList } from 'wix-dashboard-management.v2';

async function deleteUserFavorite(favoriteId) {
  try {
    const result = await favoriteList.deleteUserFavorite(favoriteId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


deleteUserFavorite example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDeleteUserFavorite = elevate(favoriteList.deleteUserFavorite);

export const deleteUserFavorite = webMethod(
  Permissions.Anyone,
  async (favoriteId) => {
    try {
      const result = await elevatedDeleteUserFavorite(favoriteId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


deleteUserFavorite example for exporting from backend code

deleteUserFavorite

DeleteUserFavoriteResponse

ID of the dashboard favorite list to delete.

favoriteListId

Deletes the user's list of favorite dashboard pages.

import { favoriteList } from 'wix-dashboard-management.v2';

async function deleteUserFavoriteList(favoriteListId) {
  try {
    const result = await favoriteList.deleteUserFavoriteList(favoriteListId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


deleteUserFavoriteList example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDeleteUserFavoriteList = elevate(favoriteList.deleteUserFavoriteList);

export const deleteUserFavoriteList = webMethod(
  Permissions.Anyone,
  async (favoriteListId) => {
    try {
      const result = await elevatedDeleteUserFavoriteList(favoriteListId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


deleteUserFavoriteList example for exporting from backend code

deleteUserFavoriteList

void

Retrieves the user's dashboard favorite list.

import { favoriteList } from 'wix-dashboard-management.v2';

async function getUserFavoriteList() {
  try {
    const result = await favoriteList.getUserFavoriteList();
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getUserFavoriteList example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetUserFavoriteList = elevate(favoriteList.getUserFavoriteList);

export const getUserFavoriteList = webMethod(
  Permissions.Anyone,
  async () => {
    try {
      const result = await elevatedGetUserFavoriteList();
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getUserFavoriteList example for exporting from backend code

getUserFavoriteList

GetUserFavoriteListResponse

Dashboard favorite list ID. Automatically generated by Wix.

UpdateUserFavoriteList

options

UpdateUserFavoriteListOptions

Updates the current user's list of favorite dashboard pages.

Make sure to include the current revision number when calling this endpoint.

> **Note:**
> Updating the list replaces the favorite pages it contains with those passed to the endpoint.

import { favoriteList } from 'wix-dashboard-management.v2';

async function updateUserFavoriteList(id, favoriteList, options) {
  try {
    const result = await favoriteList.updateUserFavoriteList(id, favoriteList, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


updateUserFavoriteList example for dashboard page code

import { favoriteList } from 'wix-dashboard-management.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedUpdateUserFavoriteList = elevate(favoriteList.updateUserFavoriteList);

export const updateUserFavoriteList = webMethod(
  Permissions.Anyone,
  async (id, favoriteList, options) => {
    try {
      const result = await elevatedUpdateUserFavoriteList(id, favoriteList, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


updateUserFavoriteList example for exporting from backend code

updateUserFavoriteList

# About the Dashboard Favorite List API

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline [Wix users](https://dev.wix.com/docs/build-an-app/develop-your-app/access/about-identities#wix-users) to [dashboard](https://support.wix.com/en/article/about-your-wix-dashboard) navigation experience and make important pages quickly accessible.

The Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline [Wix users'](https://dev.wix.com/docs/build-an-app/develop-your-app/access/about-identities#wix-users) dashboard navigation experience and make important pages quickly accessible.

With the Dashboard Favorite List API, users can:

- [Create](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/create-user-favorite-list), [retrieve](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/get-user-favorite-list), [update](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/update-user-favorite-list), and [delete](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/delete-user-favorite-list) their list of dashboard favorites.
- [Add](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/add-user-favorite) and [delete](https://dev.wix.com/docs/velo/api-reference/wix-dashboard-management-v2/favorite-list/delete-user-favorite) individual dashboard favorites to and from their list.
- Create nested views of collections, developer tools, or other dashboard pages for quick access.
- Assign custom titles to favorite pages for easier navigation.

## Before you begin

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

- Each Wix user can only have one list of favorite dashboard pages.
- We recommend you avoid making changes to the list without the user taking explicit action.
- To use the Dashboard Favorite List API, import `favoriteList` from the `wix-dashboard-management.v2` module:

  ```js
  import { favoriteList } from "wix-dashboard-management.v2";
  ```

## Use cases

- Including an **Add to Favorites** button in your [dashboard pages](https://dev.wix.com/docs/develop-websites/articles/coding-with-velo/frontend-code/dashboard-admin-pages/working-with-dashboard-pages) to streamline your [contributors'](https://support.wix.com/en/article/about-contributor-roles-permissions) dashboard navigation experience.
- Create a nested view of frequently visited dashboard pages for quick access.

## Terminology

- **Dashboard Favorite List**: A UI element that displays a list of favorite dashboard pages used for quick access.
- **Dashboard Favorite Page**: A dashboard favorite page on the list. It has a custom title, and it can have a relative URL.
- **Page**: A dashboard page.


velo-deps_wix-dashboard-management.v2_favorite-list

Date and time the dashboard favorite list was created.

_createdDate

Date and time the dashboard favorite list was last updated.

_updatedDate

favorites

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.

revision

Favorite ID. Automatically generated by Wix.

pageId

Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier.

relativeUrl

Custom title displayed in the list of favorite pages.

createUserFavoriteList( )