deleteUserFavorite( )


Developer Preview

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

Deletes the specified favorite page from the current user's list of favorite dashboard pages. If no favorites remain in the list, it is deleted.

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
favoriteIdstringRequired

ID of the favorite page to delete from the list.

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