addUserFavorite( )

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Dashboard
Learn more about app permissions.
Method Declaration
Copy
function addUserFavorite(favorite: Favorite): Promise<AddUserFavoriteResponse>;
Method Parameters
favoriteFavoriteRequired

Favorite page to add to the list.

Returns
Return Type:Promise<AddUserFavoriteResponse>
JavaScript
import { favoriteList } from "@wix/dashboard-management";

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

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?