addUserFavorite( )


Developer Preview

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

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.

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
favoriteFavoriteRequired

Favorite page to add to the list.

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