updateUserFavoriteList( )

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

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

Note: Updating the list replaces the favorite pages it contains with those specified in the method.

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 updateUserFavoriteList(
  _id: string,
  favoriteList: UpdateUserFavoriteList,
): Promise<DashboardFavoriteList>;
Method Parameters
_idstringRequired

Dashboard favorite list ID. Automatically generated by Wix.

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

async function updateUserFavoriteList(id, favoriteList) {
  const response = await favoriteList.updateUserFavoriteList(id, favoriteList);
}
Errors

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

Did this help?