POST

Add User Favorite


Adds a page to the current Wix user's list of favorite dashboard pages. If the Wix user doesn't have a list, the method creates a new list and adds the favorite page to it.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Dashboard
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite

Body Params
favoriteFavoriteRequired

Favorite page to add to the list.

Response Object
favoriteListFavoriteList

Updated dashboard favorite list.

Add Page to User Favorite List
Request
cURL
curl -X POST \ 'https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "favorite": { "pageId": "3893d33b-24a1-474b-80b0-dd7c32e20bfb", "title": "New Favorite Page" } }'
Response
JSON
{ "favoriteList": { "id": "b8216af7-cf7c-4860-8014-54e4824a1745", "revision": "16", "createdDate": "2024-05-19T13:05:45.684Z", "updatedDate": "2024-05-20T14:46:50.126Z", "favorites": [ { "id": "cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77", "pageId": "3893d33b-24a1-474b-80b0-dd7c32e20bfb", "title": "Existing favorite page" }, { "id": "10b007d6-1d67-4deb-9adf-32813f580bab", "pageId": "3893d33b-24a1-474b-80b0-dd7c32e20bfb", "title": "New Favorite Page" } ] } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?