createUserFavoriteList( )

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

Note: When first calling this method on behalf of a Wix user, you can create a list that contains one or more favorite dashboard pages. However, if a list already exists for that Wix user, calling this method generates an error.

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
Method Parameters
favoriteListDashboardFavoriteListRequired

Dashboard favorite list to create.

Returns
Return Type:Promise<DashboardFavoriteList>
Errors

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

Did this help?