{"id":"c2ed71f2-d4d7-46b5-b55d-2ecac8c3161a","createdDate":"2024-08-13T08:22:31.008Z","updatedDate":"2024-08-13T08:22:31.008Z","resourceId":"4c3d9554-43f9-45bc-94e0-4f42f14eedf8","api":{"schema":{"object":{"displayName":"Favorite List Object","description":"List of favorite dashboard pages.","slug":"favorite-list-object","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/wixos.git"},"methods":[{"summary":"Get User Favorite List","description":"Retrieves the user's dashboard favorite list.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.GetUserFavoriteList","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListResponse"},"legacyExamples":[{"name":"GetUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Get User Favorite List","request":"curl -X GET \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list' \\\n -H 'Authorization: '","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"1\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:05:45.684Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"get","path":"/v1/user-favorite-list","rpcOnly":false,"triggeredEvents":[],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_READ"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListResponse"},"legacyExamples":[{"name":"GetUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Get User Favorite List","request":"curl -X GET \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list' \\\n -H 'Authorization: '","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"1\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:05:45.684Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Get User Favorite List","slugifiedName":"get-user-favorite-list"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true},{"summary":"Create User Favorite List","description":"Creates a list of favorite dashboard pages for the current user. A user can only have one such list.\n\n> **Note:**\n> 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.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.CreateUserFavoriteList","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"CreateUserFavoriteListRequest","description":"","properties":{"favoriteList":{"description":"Dashboard favorite list to create.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["favoriteList","favoriteList.favorites"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Favorite List Created","description":"Triggered when the dashboard favorite list is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_created","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListResponse"},"legacyExamples":[{"name":"CreateUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Create User Favorite List","request":"curl -X POST \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"favoriteList\": {\n \"favorites\": [\n {\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"My Page\"\n },\n {\n \"pageId\": \"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"title\": \"Another Page\",\n \"relativeUrl\": \"/route\"\n }\n ]\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"1\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:05:45.684Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v1/user-favorite-list","rpcOnly":false,"triggeredEvents":[{"title":"Favorite List Created","description":"Triggered when the dashboard favorite list is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_created","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListResponse"},"legacyExamples":[{"name":"CreateUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Create User Favorite List","request":"curl -X POST \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"favoriteList\": {\n \"favorites\": [\n {\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"My Page\"\n },\n {\n \"pageId\": \"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"title\": \"Another Page\",\n \"relativeUrl\": \"/route\"\n }\n ]\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"1\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:05:45.684Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Create User Favorite List","slugifiedName":"create-user-favorite-list"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true},{"summary":"Update User Favorite List","description":"Updates the current user's list of favorite dashboard pages.\n\nMake sure to include the current revision number when calling this endpoint.\n\n> **Note:**\n> Updating the list replaces the favorite pages it contains with those passed to the endpoint.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.UpdateUserFavoriteList","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"favoriteList.id","description":"Dashboard favorite list ID. Automatically generated by Wix.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateUserFavoriteListRequest","description":"","properties":{"favoriteList":{"description":"Dashboard favorite list to update. The `favorites` array in the request replaces the existing `favorites` array.\n\nTo prevent conflicting changes, include the current revision number.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["favoriteList","favoriteList.id","favoriteList.revision"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListResponse"},"legacyExamples":[{"name":"UpdateUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Update User Favorite List","request":"curl -X PATCH \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/c959d429-3136-41cb-9478-6acbd064e0fa' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"favoriteList\": {\n \"revision\": 1,\n \"favorites\": [\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Updated Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"2\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:23:10.422Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Updated Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"patch","path":"/v1/user-favorite-list/{favoriteList.id}","rpcOnly":false,"triggeredEvents":[{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListResponse"},"legacyExamples":[{"name":"UpdateUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Update User Favorite List","request":"curl -X PATCH \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/c959d429-3136-41cb-9478-6acbd064e0fa' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"favoriteList\": {\n \"revision\": 1,\n \"favorites\": [\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Updated Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"2\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-19T13:23:10.422Z\",\n \"favorites\":[\n {\n \"id\":\"7d228ce4-f0c6-4758-be72-beea48f83dd1\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Updated Page\"\n },\n {\n \"id\":\"b38a93a2-89f4-4c4f-8786-618f69cde012\",\n \"pageId\":\"81f1ee0a-92b7-42f7-89cb-8b0f96146dcf\",\n \"relativeUrl\":\"/route\",\n \"title\":\"Another Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Update User Favorite List","slugifiedName":"update-user-favorite-list"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true},{"summary":"Delete User Favorite List","description":"Deletes the user's list of favorite dashboard pages.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.DeleteUserFavoriteList","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"favoriteListId","description":"ID of the dashboard favorite list to delete.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Favorite List Deleted","description":"Triggered when the dashboard favorite list is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_deleted","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListResponse"},"legacyExamples":[{"name":"DeleteUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Delete User Favorite List","request":"curl -X DELETE \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/c959d429-3136-41cb-9478-6acbd064e0fa' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"delete","path":"/v1/user-favorite-list/{favoriteListId}","rpcOnly":false,"triggeredEvents":[{"title":"Favorite List Deleted","description":"Triggered when the dashboard favorite list is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_deleted","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListResponse"},"legacyExamples":[{"name":"DeleteUserFavoriteList","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Delete User Favorite List","request":"curl -X DELETE \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/c959d429-3136-41cb-9478-6acbd064e0fa' \\\n -H 'Authorization: '","response":"{}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Delete User Favorite List","slugifiedName":"delete-user-favorite-list"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true},{"summary":"Add User Favorite","description":"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.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.AddUserFavorite","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.AddUserFavoriteResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"AddUserFavoriteRequest","description":"","properties":{"favorite":{"description":"Favorite page to add to the list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.Favorite","summary":"favorite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["favorite"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Favorite List Created","description":"Triggered when the dashboard favorite list is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_created","sourceRepo":"git@github.com:wix-private/wixos.git"},{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteResponse"},"legacyExamples":[{"name":"AddUserFavorite","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Add Page to User Favorite List","request":"curl -X POST \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"favorite\": {\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"New Favorite Page\"\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"16\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-20T14:46:50.126Z\",\n \"favorites\":[\n {\n \"id\":\"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"Existing favorite page\"\n },\n {\n \"id\":\"10b007d6-1d67-4deb-9adf-32813f580bab\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"New Favorite Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"post","path":"/v1/user-favorite-list/add-favorite","rpcOnly":false,"triggeredEvents":[{"title":"Favorite List Created","description":"Triggered when the dashboard favorite list is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_created","sourceRepo":"git@github.com:wix-private/wixos.git"},{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteResponse"},"legacyExamples":[{"name":"AddUserFavorite","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Add Page to User Favorite List","request":"curl -X POST \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/add-favorite' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n -d '{\n \"favorite\": {\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"New Favorite Page\"\n }\n }'","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"16\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-20T14:46:50.126Z\",\n \"favorites\":[\n {\n \"id\":\"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"Existing favorite page\"\n },\n {\n \"id\":\"10b007d6-1d67-4deb-9adf-32813f580bab\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"New Favorite Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Add User Favorite","slugifiedName":"add-user-favorite"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true},{"summary":"Delete User Favorite","description":"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.","operationId":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService.DeleteUserFavorite","parameters":[{"in":"path","schema":{"type":"string"},"required":true,"name":"favoriteId","description":"ID of the favorite page to delete from the list.","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}],"responses":{"200":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/dashboard/v1/user-favorite-list","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/dashboard/v1/user-favorite-list","destinationPath":"/v1/user-favorite-list","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[{"title":"Favorite List Deleted","description":"Triggered when the dashboard favorite list is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_deleted","sourceRepo":"git@github.com:wix-private/wixos.git"},{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteResponse"},"legacyExamples":[{"name":"DeleteUserFavorite","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Delete Page from User Favorite List","request":"curl -X DELETE \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/delete-favorite/cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77' \\\n -H 'Authorization: '","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"17\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-20T14:46:50.126Z\",\n \"favorites\":[\n {\n \"id\":\"10b007d6-1d67-4deb-9adf-32813f580bab\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Favorite Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git"},"httpMethod":"delete","path":"/v1/user-favorite-list/delete-favorite/{favoriteId}","rpcOnly":false,"triggeredEvents":[{"title":"Favorite List Deleted","description":"Triggered when the dashboard favorite list is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_deleted","sourceRepo":"git@github.com:wix-private/wixos.git"},{"title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","sourceRepo":"git@github.com:wix-private/wixos.git"}],"serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["DASHBOARD.FAVORITES_WRITE"],"applicableIdentities":["APP"],"externalPermissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"protoArtifactId":"com.wixpress.os.giza.backoffice.favorites:backoffice-favorites","serviceArtifactId":"com.wixpress.os.giza.backoffice.favorites.backoffice-favorites","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteRequest","responseMessage":"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteResponse"},"legacyExamples":[{"name":"DeleteUserFavorite","serviceName":"DashboardFavoritesService","type":"METHOD","content":{"title":"Delete Page from User Favorite List","request":"curl -X DELETE \\\n 'https://www.wixapis.com/dashboard/v1/user-favorite-list/delete-favorite/cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77' \\\n -H 'Authorization: '","response":"{\n \"favoriteList\":{\n \"id\":\"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\":\"17\",\n \"createdDate\":\"2024-05-19T13:05:45.684Z\",\n \"updatedDate\":\"2024-05-20T14:46:50.126Z\",\n \"favorites\":[\n {\n \"id\":\"10b007d6-1d67-4deb-9adf-32813f580bab\",\n \"pageId\":\"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\":\"My Favorite Page\"\n }\n ]\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/wixos.git","contentLink":{"displayName":"Delete User Favorite","slugifiedName":"delete-user-favorite"},"permissionScopes":[{"name":"Manage Dashboard","scopeId":"SCOPE.DC-OS.MANAGE_DASHBOARD"}],"isAdminMethod":true}],"webhooks":[{"summary":"Favorite List Created","title":"Favorite List Created","description":"Triggered when the dashboard favorite list is created.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"created","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"CREATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_created","legacyExamples":[{"name":"FavoriteListCreated","eventType":"CREATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"ef87fe69-3b57-4149-9694-fe9723dcc99b\",\n \"entityFqdn\": \"wix.os.backoffice.v1.favorites\",\n \"slug\": \"created\",\n \"entityId\": \"67214477-f886-4583-a4cc-60495f5e2e78\",\n \"createdEvent\": {\n \"entity\": {\n \"id\": \"67214477-f886-4583-a4cc-60495f5e2e78\",\n \"revision\": \"1\",\n \"createdDate\": \"2024-05-21T16:38:23.355Z\",\n \"updatedDate\": \"2024-05-21T16:38:23.355Z\",\n \"favorites\": [\n {\n \"id\": \"5332fd97-e2dd-4eb2-b59e-c0f84c1c9895\",\n \"pageId\": \"5077a343-8f35-46b7-9942-d7a526555eb0\",\n \"title\": \"First Favorite\"\n },\n {\n \"id\": \"96dc7876-0203-47a6-9654-45a30dbc65cd\",\n \"pageId\": \"dd0f5103-00ac-4303-827f-f08b4de2f163\",\n \"title\": \"Second Favorite\"\n }\n ]\n }\n },\n \"eventTime\": \"2024-05-21T16:38:23.471478546Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"1\"\n}\n\n"}],"sourceRepo":"git@github.com:wix-private/wixos.git","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","contentLink":{"displayName":"Favorite List Created","slugifiedName":"favorite-list-created"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Favorite List Updated","title":"Favorite List Updated","description":"Triggered when the dashboard favorite list is updated.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_updated","legacyExamples":[{"name":"FavoriteListUpdated","eventType":"UPDATED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"3f53095f-d6ba-455c-b907-2bee6f1389f9\",\n \"entityFqdn\": \"wix.os.backoffice.v1.favorites\",\n \"slug\": \"updated\",\n \"entityId\": \"67214477-f886-4583-a4cc-60495f5e2e78\",\n \"updatedEvent\": {\n \"currentEntity\": {\n \"id\": \"67214477-f886-4583-a4cc-60495f5e2e78\",\n \"revision\": \"5\",\n \"createdDate\": \"2024-05-21T16:38:23.355Z\",\n \"updatedDate\": \"2024-05-21T16:53:40.493Z\",\n \"favorites\": [\n {\n \"id\": \"5332fd97-e2dd-4eb2-b59e-c0f84c1c9895\",\n \"pageId\": \"5077a343-8f35-46b7-9942-d7a526555eb0\",\n \"title\": \"Updated First Favorite\"\n },\n {\n \"id\": \"96dc7876-0203-47a6-9654-45a30dbc65cd\",\n \"pageId\": \"dd0f5103-00ac-4303-827f-f08b4de2f163\",\n \"title\": \"Second Favorite\"\n }\n ]\n }\n },\n \"eventTime\": \"2024-05-21T16:53:40.612668746Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"5\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/wixos.git","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","contentLink":{"displayName":"Favorite List Updated","slugifiedName":"favorite-list-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]},{"summary":"Favorite List Deleted","title":"Favorite List Deleted","description":"Triggered when the dashboard favorite list is deleted.","permissions":[],"exposure":"PUBLIC","maturity":"GA","slug":"deleted","eventTopic":"domain_events_wix.dashboard.v1.favorite_list","serviceName":"wix.os.giza.backoffice.favorites.v1.DashboardFavoritesService","domainEvent":"DELETED","externalPermissionScopes":[],"eventType":"wix.dashboard.v1.favorite_list_deleted","legacyExamples":[{"name":"FavoriteListDeleted","eventType":"DELETED","type":"DOMAIN_EVENT","content":"{\n \"id\": \"97d59647-d68f-4c3f-9fed-d3642556164c\",\n \"entityFqdn\": \"wix.os.backoffice.v1.favorites\",\n \"slug\": \"deleted\",\n \"entityId\": \"67214477-f886-4583-a4cc-60495f5e2e78\",\n \"deletedEvent\": {\n \"movedToTrash\": true\n },\n \"eventTime\": \"2024-05-21T16:54:00.675636253Z\",\n \"triggeredByAnonymizeRequest\": false,\n \"entityEventSequence\": \"15\"\n}\n"}],"sourceRepo":"git@github.com:wix-private/wixos.git","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","contentLink":{"displayName":"Favorite List Deleted","slugifiedName":"favorite-list-deleted"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"permissionScopes":[]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Dashboard Favorite List API\n\nThe Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline [Wix users'](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/access/about-identities#wix-users) dashboard navigation experience and make important pages quickly accessible.\n\nWith the Dashboard Favorite List API, you can:\n\n- [Create](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/create-user-favorite-list), [retrieve](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/get-user-favorite-list), [update](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/update-user-favorite-list), and [delete](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite-list) a user's list of dashboard favorites.\n- [Add](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/add-user-favorite) and [delete](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite) individual dashboard favorites from a user's list.\n- [Create nested views](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/sample-flows) of collections, developer tools, or other dashboard pages for quick access.\n- Assign custom titles to favorite pages for easier navigation.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- Each Wix user can only have one list of favorite dashboard pages.\n- We recommend you avoid making changes to the list without the user taking explicit action.\n\n## Use cases\n\n- Increase app usage by including an **Add to Favorites** button in your app's [dashboard page extensions](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions).\n- Create a nested view of frequently visited dashboard pages for quick access.\n- Create a standalone **Add to Favorites** [dashboard plugin extension](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/about-dashboard-plugin-extensions) that can be added to a supported [dashboard page slot](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/supported-wix-app-dashboard-pages/about-dashboard-page-slots).\n\n## Terminology\n\n- **Dashboard Favorite List**: A UI element that displays a list of favorite dashboard pages used for quick access.\n- **Dashboard Favorite Page**: A dashboard favorite page on the list. It has a custom title, and it can have a relative URL.\n- **Page**: A dashboard page.\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flow\n\nThis article presents a sample use case your service might support. You are not limited to this exact flow, but it can serve as a good starting point to help you plan your service's implementation.\n\n## Provide quick access to a nested dashboard page\n\nA Wix app provides a service that includes multiple [dashboard page extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions), some nested in others.\n\nTo increase app usage and allow the user to quickly access its main features, add an **Add to Favorites** / **Delete From Favorites** button to its main dashboard pages:\n\n1. Add an **Add to Favorites** button to your app's [dashboard pages](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions). To create an intuitive user experience, consider using the [Wix Design System](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::961b3d4d-c23e-4966-9065-bfa05546240f*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/wix-design-system/about-the-wix-design-system).\n2. When the user clicks the button on one of the pages, your app sends that page's details to the [Add User Favorite](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/add-user-favorite) endpoint. Make sure to [include the page ID](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/find-a-dashboard-extension-id#extension-types-and-their-ids) and optional navigation parameters. You can also add a custom page title that appears in the UI:\n\n The request body looks like this:\n\n ```json\n \"favorite\": {\n \"pageId\": \"3893d33b-9fm4-474b-80b0-dd7c32e20bfc\",\n \"relativeUrl\": \"/limited-edition/analytics\",\n \"title\": \"Limited Edition Products Analytics\"\n }\n ```\n\n The endpoint creates a favorite page with the dashboard page's details, adds it to the list, and responds with the updated list of favorite dashboard pages. The response looks like this:\n\n ```json\n {\n \"favoriteList\": {\n \"id\": \"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-05-19T13:05:45.684Z\",\n \"updatedDate\": \"2024-05-20T14:46:50.126Z\",\n \"favorites\": [\n {\n \"id\": \"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"Existing favorite page\"\n },\n {\n \"id\": \"10b007d6-1d67-4deb-9adf-32813f580bab\", // The ID of the favorite page created\n \"pageId\": \"3893d33b-9fm4-474b-80b0-dd7c32e20bfc\",\n \"relativeUrl\": \"/limited-edition/analytics\",\n \"title\": \"Limited Edition Products Analytics\"\n }\n ]\n }\n }\n ```\n\n3. Your app might now replace the **Add to Favorites** button with a **Remove from Favorites** button. When the user clicks it, your app calls the [Delete User Favorite](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite) endpoint with the favorite `id` appended to the endpoint base URL: `https://www.wixapis.com/dashboard/v1/user-favorite-list/delete-favorite/10b007d6-1d67-4deb-9adf-32813f580bab`\n\n The endpoint removes the page from the list of favorites and returns the updated list. The response looks like this:\n\n ```json\n {\n \"favoriteList\": {\n \"id\": \"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-05-21T13:05:45.684Z\",\n \"updatedDate\": \"2024-05-22T14:46:50.126Z\",\n \"favorites\": [\n {\n \"id\": \"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"Existing favorite page\"\n }\n ]\n }\n }\n ```\n"}],"components":{"schemas":{"wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList":{"type":"object","properties":{"id":{"description":"Dashboard favorite list ID. Automatically generated by Wix.","format":"GUID","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"revision":{"description":"Revision number. Increments automatically by 1 whenever the list is successfully updated. To prevent conflicting changes, pass the current revision number when updating the list.","readOnly":true,"title":"revision","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the dashboard favorite list was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the dashboard favorite list was last updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"favorites":{"description":"List of favorite dashboard pages.","maxItems":100,"title":"favorites","type":"array","items":{"$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.Favorite"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DashboardFavoriteList","description":"List of favorite dashboard pages."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"wix.os.giza.backoffice.favorites.v1.Favorite":{"type":"object","properties":{"id":{"description":"Favorite ID. Automatically generated by Wix.","format":"GUID","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pageId":{"description":"ID of the page added to the list.","minLength":1,"maxLength":200,"title":"pageId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"relativeUrl":{"description":"Relative URL appended to the page's URL for customizing the navigation. It can include path segments, a query string, or a fragment identifier.","maxLength":500,"title":"relativeUrl","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"title":{"description":"Custom title displayed in the list of favorite pages.","minLength":1,"maxLength":40,"title":"title","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Favorite","description":""},"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListRequest":{"type":"object","properties":{"favoriteList":{"description":"Dashboard favorite list to create.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateUserFavoriteListRequest","description":""},"wix.os.giza.backoffice.favorites.v1.CreateUserFavoriteListResponse":{"type":"object","properties":{"favoriteList":{"description":"Created dashboard favorite list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"CreateUserFavoriteListResponse","description":""},"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListRequest":{"type":"object","properties":{},"title":"GetUserFavoriteListRequest","description":""},"wix.os.giza.backoffice.favorites.v1.GetUserFavoriteListResponse":{"type":"object","properties":{"favoriteList":{"description":"User's dashboard favorite list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetUserFavoriteListResponse","description":""},"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListRequest":{"type":"object","properties":{"favoriteList":{"description":"Dashboard favorite list to update. The `favorites` array in the request replaces the existing `favorites` array.\n\nTo prevent conflicting changes, include the current revision number.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateUserFavoriteListRequest","description":""},"google.protobuf.FieldMask":{"type":"object","properties":{"paths":{"description":"","title":"paths","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FieldMask","description":""},"wix.os.giza.backoffice.favorites.v1.UpdateUserFavoriteListResponse":{"type":"object","properties":{"favoriteList":{"description":"Updated dashboard favorite list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateUserFavoriteListResponse","description":""},"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListRequest":{"type":"object","properties":{"favoriteListId":{"description":"ID of the dashboard favorite list to delete.","format":"GUID","title":"favoriteListId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteUserFavoriteListRequest","description":""},"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteListResponse":{"type":"object","properties":{},"title":"DeleteUserFavoriteListResponse","description":""},"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteRequest":{"type":"object","properties":{"favorite":{"description":"Favorite page to add to the list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.Favorite","summary":"favorite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddUserFavoriteRequest","description":""},"wix.os.giza.backoffice.favorites.v1.AddUserFavoriteResponse":{"type":"object","properties":{"favoriteList":{"description":"Updated dashboard favorite list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"AddUserFavoriteResponse","description":""},"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteRequest":{"type":"object","properties":{"favoriteId":{"description":"ID of the favorite page to delete from the list.","format":"GUID","title":"favoriteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteUserFavoriteRequest","description":""},"wix.os.giza.backoffice.favorites.v1.DeleteUserFavoriteResponse":{"type":"object","properties":{"favoriteList":{"description":"Updated dashboard favorite list.","$ref":"#/components/schemas/wix.os.giza.backoffice.favorites.v1.DashboardFavoriteList","summary":"favoriteList","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteUserFavoriteResponse","description":""},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example: 2020-04-26T13:57:50.699Z","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"restoreInfo":{"description":"Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity","$ref":"#/components/schemas/wix.common.domainevents.RestoreInfo","summary":"restoreInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.RestoreInfo":{"type":"object","properties":{"deletedDate":{"description":"","title":"deletedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"RestoreInfo","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Favorite List","description":"List of favorite dashboard pages.","fqdn":"wix.dashboard.v1.favorite_list"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About the Dashboard Favorite List API\n\nThe Dashboard Favorite List API provides functionality to create and manage a list of favorite dashboard pages. It allows you to streamline [Wix users'](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/access/about-identities#wix-users) dashboard navigation experience and make important pages quickly accessible.\n\nWith the Dashboard Favorite List API, you can:\n\n- [Create](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/create-user-favorite-list), [retrieve](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/get-user-favorite-list), [update](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/update-user-favorite-list), and [delete](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite-list) a user's list of dashboard favorites.\n- [Add](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/add-user-favorite) and [delete](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite) individual dashboard favorites from a user's list.\n- [Create nested views](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/sample-flows) of collections, developer tools, or other dashboard pages for quick access.\n- Assign custom titles to favorite pages for easier navigation.\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n- Each Wix user can only have one list of favorite dashboard pages.\n- We recommend you avoid making changes to the list without the user taking explicit action.\n\n## Use cases\n\n- Increase app usage by including an **Add to Favorites** button in your app's [dashboard page extensions](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-pages/about-dashboard-page-extensions).\n- Create a nested view of frequently visited dashboard pages for quick access.\n- Create a standalone **Add to Favorites** [dashboard plugin extension](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/about-dashboard-plugin-extensions) that can be added to a supported [dashboard page slot](fallback::https://dev.wix.com/docs/build-an-app/develop-your-app/extensions/dashboard-extensions/dashboard-plugins/supported-wix-app-dashboard-pages/about-dashboard-page-slots).\n\n## Terminology\n\n- **Dashboard Favorite List**: A UI element that displays a list of favorite dashboard pages used for quick access.\n- **Dashboard Favorite Page**: A dashboard favorite page on the list. It has a custom title, and it can have a relative URL.\n- **Page**: A dashboard page.\n"},{"displayName":"Sample Flows","slugifyName":"sample-flows","content":"# Sample Flow\n\nThis article presents a sample use case your service might support. You are not limited to this exact flow, but it can serve as a good starting point to help you plan your service's implementation.\n\n## Provide quick access to a nested dashboard page\n\nA Wix app provides a service that includes multiple [dashboard page extensions](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions), some nested in others.\n\nTo increase app usage and allow the user to quickly access its main features, add an **Add to Favorites** / **Delete From Favorites** button to its main dashboard pages:\n\n1. Add an **Add to Favorites** button to your app's [dashboard pages](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/about-dashboard-extensions). To create an intuitive user experience, consider using the [Wix Design System](portalId::63e3acd8-2a9c-421d-8f92-d02930eeb59eresourceId::961b3d4d-c23e-4966-9065-bfa05546240f*fallback::https://dev.wix.com/docs/build-apps/develop-your-app/wix-design-system/about-the-wix-design-system).\n2. When the user clicks the button on one of the pages, your app sends that page's details to the [Add User Favorite](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/add-user-favorite) endpoint. Make sure to [include the page ID](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/extensions/dashboard-extensions/find-a-dashboard-extension-id#extension-types-and-their-ids) and optional navigation parameters. You can also add a custom page title that appears in the UI:\n\n The request body looks like this:\n\n ```json\n \"favorite\": {\n \"pageId\": \"3893d33b-9fm4-474b-80b0-dd7c32e20bfc\",\n \"relativeUrl\": \"/limited-edition/analytics\",\n \"title\": \"Limited Edition Products Analytics\"\n }\n ```\n\n The endpoint creates a favorite page with the dashboard page's details, adds it to the list, and responds with the updated list of favorite dashboard pages. The response looks like this:\n\n ```json\n {\n \"favoriteList\": {\n \"id\": \"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\": \"2\",\n \"createdDate\": \"2024-05-19T13:05:45.684Z\",\n \"updatedDate\": \"2024-05-20T14:46:50.126Z\",\n \"favorites\": [\n {\n \"id\": \"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"Existing favorite page\"\n },\n {\n \"id\": \"10b007d6-1d67-4deb-9adf-32813f580bab\", // The ID of the favorite page created\n \"pageId\": \"3893d33b-9fm4-474b-80b0-dd7c32e20bfc\",\n \"relativeUrl\": \"/limited-edition/analytics\",\n \"title\": \"Limited Edition Products Analytics\"\n }\n ]\n }\n }\n ```\n\n3. Your app might now replace the **Add to Favorites** button with a **Remove from Favorites** button. When the user clicks it, your app calls the [Delete User Favorite](fallback::https://dev.wix.com/docs/rest/business-management/dashboard/dashboard-favorite-list/delete-user-favorite) endpoint with the favorite `id` appended to the endpoint base URL: `https://www.wixapis.com/dashboard/v1/user-favorite-list/delete-favorite/10b007d6-1d67-4deb-9adf-32813f580bab`\n\n The endpoint removes the page from the list of favorites and returns the updated list. The response looks like this:\n\n ```json\n {\n \"favoriteList\": {\n \"id\": \"b8216af7-cf7c-4860-8014-54e4824a1745\",\n \"revision\": \"3\",\n \"createdDate\": \"2024-05-21T13:05:45.684Z\",\n \"updatedDate\": \"2024-05-22T14:46:50.126Z\",\n \"favorites\": [\n {\n \"id\": \"cc5a0ad9-dbc8-4139-b4e2-3c59678a7d77\",\n \"pageId\": \"3893d33b-24a1-474b-80b0-dd7c32e20bfb\",\n \"title\": \"Existing favorite page\"\n }\n ]\n }\n }\n ```\n"}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}