createUserFavoriteList( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Dashboard
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
favoriteListDashboardFavoriteListRequired

Dashboard favorite list to create.

Returns
Return Type:Promise<DashboardFavoriteList>
Was this helpful?
Yes
No