PATCH

Update User Favorite List


Updates the current Wix user's list of favorite dashboard pages.

Make sure to include the current revision number when calling this method.

Note: Updating the list replaces the favorite pages it contains with those specified in the method.

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
PATCH
https://www.wixapis.com/dashboard/v1/user-favorite-list/{favoriteList.id}

Path Params
favoriteList.idstringRequired

Dashboard favorite list ID. Automatically generated by Wix.

Body Params
favoriteListFavoriteListRequired

Dashboard favorite list to update. The favorites array in the request replaces the existing favorites array.

To prevent conflicting changes, include the current revision number.

Response Object
favoriteListFavoriteList

Updated dashboard favorite list.

Update User Favorite List
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/dashboard/v1/user-favorite-list/c959d429-3136-41cb-9478-6acbd064e0fa' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "favoriteList": { "revision": 1, "favorites": [ { "id":"7d228ce4-f0c6-4758-be72-beea48f83dd1", "pageId":"3893d33b-24a1-474b-80b0-dd7c32e20bfb", "title":"My Updated Page" }, { "id":"b38a93a2-89f4-4c4f-8786-618f69cde012", "pageId":"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf", "relativeUrl":"/route", "title":"Another Page" } ] } }'
Response
JSON
{ "favoriteList": { "id": "b8216af7-cf7c-4860-8014-54e4824a1745", "revision": "2", "createdDate": "2024-05-19T13:05:45.684Z", "updatedDate": "2024-05-19T13:23:10.422Z", "favorites": [ { "id": "7d228ce4-f0c6-4758-be72-beea48f83dd1", "pageId": "3893d33b-24a1-474b-80b0-dd7c32e20bfb", "title": "My Updated Page" }, { "id": "b38a93a2-89f4-4c4f-8786-618f69cde012", "pageId": "81f1ee0a-92b7-42f7-89cb-8b0f96146dcf", "relativeUrl": "/route", "title": "Another 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?