\n\n__Important:__\nWhen creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n\n

","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"createGalleryItem","fqn":"createGalleryItem","slug":"create-gallery-item","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["galleryId","item","item.image.imageInfo","item.text.html","item.video.videoInfo"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Item","referenceFqn":"Item"},"description":"Created media item."},"examples":[{"title":"createGalleryItem: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function createGalleryItem(galleryId, item) {\n const response = await proGallery.createGalleryItem(galleryId, item);\n};"},{"title":"createGalleryItem: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function createGalleryItem(galleryId, item) {\n const response = await myWixClient.proGallery.createGalleryItem(galleryId, item);\n};"}],"actionParams":[{"name":"galleryId","slug":"gallery-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gallery ID."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Item","referenceFqn":"Item"},"description":"Media item to create."}],"description":"Creates a media item in a specified gallery.\n\nThe `createGalleryItem()` function returns a Promise that resolves to a newly-created gallery item after it has successfully been created.\n\n

\n\n__Important:__\nWhen creating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n\n

","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"deleteGallery","fqn":"deleteGallery","slug":"delete-gallery","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["galleryId"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteGalleryResponse","referenceFqn":"DeleteGalleryResponse"}},"examples":[{"title":"deleteGallery: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function deleteGallery(galleryId) {\n const response = await proGallery.deleteGallery(galleryId);\n};"},{"title":"deleteGallery: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteGallery(galleryId) {\n const response = await myWixClient.proGallery.deleteGallery(galleryId);\n};"}],"actionParams":[{"name":"galleryId","slug":"gallery-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the gallery to delete."}],"description":"Deletes a gallery.\n\nWhen a gallery is deleted, the deleted gallery is no longer returned when calling the [`listGalleries()`](/pro-gallery/list-galleries) function.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"deleteGalleryItem","fqn":"deleteGalleryItem","slug":"delete-gallery-item","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["identifiers","identifiers.galleryId","identifiers.itemId"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteGalleryItemResponse","referenceFqn":"DeleteGalleryItemResponse"}},"examples":[{"title":"deleteGalleryItem: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function deleteGalleryItem(identifiers) {\n const response = await proGallery.deleteGalleryItem(identifiers);\n};"},{"title":"deleteGalleryItem: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteGalleryItem(identifiers) {\n const response = await myWixClient.proGallery.deleteGalleryItem(identifiers);\n};"}],"actionParams":[{"name":"identifiers","slug":"identifiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteGalleryItemIdentifiers","referenceFqn":"DeleteGalleryItemIdentifiers"},"description":"Gallery ID and Item ID."}],"description":"Deletes a media item from a gallery.\n\nWhen a gallery item is deleted, the deleted gallery item is no longer returned when calling the [`listGalleryItems()`](/pro-gallery/list-gallery-items) function.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"deleteGalleryItems","fqn":"deleteGalleryItems","slug":"delete-gallery-items","isDeprecated":true,"isInternal":false,"actionErrors":[],"deprecation":{"message":"","replacedBy":"com.wixpress.exposure.progallery.BulkDeleteGalleryItems","targetRemovalDate":"2024-08-15"},"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["galleryId"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"DeleteGalleryItemsResponse","referenceFqn":"DeleteGalleryItemsResponse"}},"examples":[{"title":"deleteGalleryItems: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function deleteGalleryItems(galleryId, options) {\n const response = await proGallery.deleteGalleryItems(galleryId, options);\n};"},{"title":"deleteGalleryItems: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function deleteGalleryItems(galleryId, options) {\n const response = await myWixClient.proGallery.deleteGalleryItems(galleryId, options);\n};"}],"actionParams":[{"name":"galleryId","slug":"gallery-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gallery ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeleteGalleryItemsOptions","referenceFqn":"DeleteGalleryItemsOptions"}}],"description":"Deletes multiple media items from a gallery.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"getGallery","fqn":"getGallery","slug":"get-gallery","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["galleryId"],"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Gallery","referenceFqn":"Gallery"},"description":"Returned gallery."},"examples":[{"title":"getGallery: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function getGallery(galleryId, options) {\n const response = await proGallery.getGallery(galleryId, options);\n};"},{"title":"getGallery: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getGallery(galleryId, options) {\n const response = await myWixClient.proGallery.getGallery(galleryId, options);\n};"}],"actionParams":[{"name":"galleryId","slug":"gallery-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gallery ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetGalleryOptions","referenceFqn":"GetGalleryOptions"},"description":"Options to use when getting the gallery."}],"description":"Retrieves a gallery by ID.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}],"isAdminMethod":false},{"name":"getGalleryItem","fqn":"getGalleryItem","slug":"get-gallery-item","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["identifiers","identifiers.galleryId","identifiers.itemId"],"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Item","referenceFqn":"Item"},"description":"Returned media item."},"examples":[{"title":"getGalleryItem: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function getGalleryItem(identifiers) {\n const response = await proGallery.getGalleryItem(identifiers);\n};"},{"title":"getGalleryItem: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function getGalleryItem(identifiers) {\n const response = await myWixClient.proGallery.getGalleryItem(identifiers);\n};"}],"actionParams":[{"name":"identifiers","slug":"identifiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GetGalleryItemIdentifiers","referenceFqn":"GetGalleryItemIdentifiers"},"description":"Gallery ID and Item ID."}],"description":"Retrieves a gallery item by ID.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}],"isAdminMethod":false},{"name":"listGalleries","fqn":"listGalleries","slug":"list-galleries","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListGalleriesResponse","referenceFqn":"ListGalleriesResponse"}},"examples":[{"title":"listGalleries: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function listGalleries(options) {\n const response = await proGallery.listGalleries(options);\n};"},{"title":"listGalleries: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listGalleries(options) {\n const response = await myWixClient.proGallery.listGalleries(options);\n};"}],"actionParams":[{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListGalleriesOptions","referenceFqn":"ListGalleriesOptions"},"description":"Options to use when getting the list of galleries."}],"description":"Retrieves a list of galleries.\n\nThis function retrieves a list of up to 10 galleries at a given time. To list the next 10 galleries in your site's backend, use the `offset` parameter.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}],"isAdminMethod":false},{"name":"listGalleryItems","fqn":"listGalleryItems","slug":"list-gallery-items","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["galleryId"],"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListGalleryItemsResponse","referenceFqn":"ListGalleryItemsResponse"}},"examples":[{"title":"listGalleryItems: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function listGalleryItems(galleryId, options) {\n const response = await proGallery.listGalleryItems(galleryId, options);\n};"},{"title":"listGalleryItems: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function listGalleryItems(galleryId, options) {\n const response = await myWixClient.proGallery.listGalleryItems(galleryId, options);\n};"}],"actionParams":[{"name":"galleryId","slug":"gallery-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gallery ID."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ListGalleryItemsOptions","referenceFqn":"ListGalleryItemsOptions"},"description":"Options to use when getting the list of gallery items."}],"description":"Retrieves a list of media items in a specified gallery.\n\nThis function retrieves a list of up to 100 gallery items. The gallery items are listed by `sortOrder` in descending order.","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}],"isAdminMethod":false},{"name":"updateGallery","fqn":"updateGallery","slug":"update-gallery","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id","gallery","gallery.items.image.imageInfo","gallery.items.text.html","gallery.items.video.videoInfo"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Gallery","referenceFqn":"Gallery"},"description":"Updated gallery."},"examples":[{"title":"updateGallery: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function updateGallery(id, gallery) {\n const response = await proGallery.updateGallery(id, gallery);\n};"},{"title":"updateGallery: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateGallery(id, gallery) {\n const response = await myWixClient.proGallery.updateGallery(id, gallery);\n};"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the gallery to update."},{"name":"gallery","slug":"gallery","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateGallery","referenceFqn":"UpdateGallery"},"description":"The information for the gallery being updated."}],"description":"Updates a gallery.\n\nOnly the fields in the `gallery` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n\n

\n\n__Important:__\nWhen updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n\n

","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true},{"name":"updateGalleryItem","fqn":"updateGalleryItem","slug":"update-gallery-item","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["identifiers","identifiers.galleryId","identifiers.itemId","item","item.image.imageInfo","item.text.html","item.video.videoInfo"],"permissionIds":["PRO_GALLERY.MANAGE"],"permissions":["Manage Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"],"applicableIdentities":["APP"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Item","referenceFqn":"Item"},"description":"Updated media item."},"examples":[{"title":"updateGalleryItem: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nasync function updateGalleryItem(identifiers, item) {\n const response = await proGallery.updateGalleryItem(identifiers, item);\n};"},{"title":"updateGalleryItem: Self-hosted","description":"Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).","content":"import { createClient } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n// Import the auth strategy for the relevant access type\n// Import the relevant host module if needed\n\nconst myWixClient = createClient ({\n modules: { proGallery },\n // Include the auth strategy and host as relevant\n});\n\n\nasync function updateGalleryItem(identifiers, item) {\n const response = await myWixClient.proGallery.updateGalleryItem(identifiers, item);\n};"}],"actionParams":[{"name":"identifiers","slug":"identifiers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateGalleryItemIdentifiers","referenceFqn":"UpdateGalleryItemIdentifiers"},"description":"Gallery ID and Item ID."},{"name":"item","slug":"item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateGalleryItem","referenceFqn":"UpdateGalleryItem"},"description":"The information for the gallery item being updated."}],"description":"Updates a media item in a specified gallery.\n\nOnly the fields in the `item` object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.\n\n

\n\n__Important:__\nWhen updating `image` items in your gallery, the images must be uploaded to the [Wix Media Manager](https://support.wix.com/en/article/wix-media-uploading-media-to-the-media-manager) first as the `imageInfo` parameter currently only supports the Wix media URL.\n\n

","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"}],"isAdminMethod":true}],"webhooks":[{"name":"onGalleryCreated","fqn":"onGalleryCreated","slug":"on-gallery-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryCreatedHandler","referenceFqn":"OnGalleryCreatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a gallery is created.\n\n> __Note:__ The event data doesn't include gallery items or their IDs.\n> To receive information about the created items you need to listen to the [Gallery Item Created webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-created-webhook).","examples":[{"title":"onGalleryCreated: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryCreated((event) => {\n // handle your event here\n});"},{"title":"onGalleryCreated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_created","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]},{"name":"onGalleryDeleted","fqn":"onGalleryDeleted","slug":"on-gallery-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryDeletedHandler","referenceFqn":"OnGalleryDeletedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a gallery is deleted.","examples":[{"title":"onGalleryDeleted: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryDeleted((event) => {\n // handle your event here\n});"},{"title":"onGalleryDeleted: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_deleted","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]},{"name":"onGalleryItemCreated","fqn":"onGalleryItemCreated","slug":"on-gallery-item-created","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryItemCreatedHandler","referenceFqn":"OnGalleryItemCreatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a media item in a specified gallery is created.","examples":[{"title":"onGalleryItemCreated: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryItemCreated((event) => {\n // handle your event here\n});"},{"title":"onGalleryItemCreated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryItemCreated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_gallery_item_created","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]},{"name":"onGalleryItemDeleted","fqn":"onGalleryItemDeleted","slug":"on-gallery-item-deleted","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryItemDeletedHandler","referenceFqn":"OnGalleryItemDeletedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a media item in a specified gallery is deleted.\n\n> __Note:__ The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.\n> The property `originatedFrom` has the value `Gallery Deleted` if the entire gallery is deleted. If the gallery item is deleted individually, this field is empty.","examples":[{"title":"onGalleryItemDeleted: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryItemDeleted((event) => {\n // handle your event here\n});"},{"title":"onGalleryItemDeleted: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryItemDeleted((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_gallery_item_deleted","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]},{"name":"onGalleryItemUpdated","fqn":"onGalleryItemUpdated","slug":"on-gallery-item-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryItemUpdatedHandler","referenceFqn":"OnGalleryItemUpdatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a media item in a specified gallery is updated.","examples":[{"title":"onGalleryItemUpdated: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryItemUpdated((event) => {\n // handle your event here\n});"},{"title":"onGalleryItemUpdated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryItemUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_gallery_item_updated","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]},{"name":"onGalleryUpdated","fqn":"onGalleryUpdated","slug":"on-gallery-updated","isDeprecated":false,"actionParams":[{"name":"handler","slug":"handler","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnGalleryUpdatedHandler","referenceFqn":"OnGalleryUpdatedHandler","isFunction":true}}],"isDeveloperPreview":true,"maturity":"GA","description":"Triggered when a gallery is updated.\n\n> __Note:__ The event data doesn't include gallery items or their IDs.\n> To receive information about the updated items you need to listen to the [Gallery Item Updated webhook](https://dev.wix.com/api/rest/site-content/pro-gallery/gallery-item-updated-webhook).","examples":[{"title":"onGalleryUpdated: Wix-hosted","content":"import { proGallery } from '@wix/pro-gallery';\n\nproGallery.onGalleryUpdated((event) => {\n // handle your event here\n});"},{"title":"onGalleryUpdated: Self-hosted","content":"import { createClient, AppStrategy } from '@wix/sdk';\nimport { proGallery } from '@wix/pro-gallery';\n\nconst wixClient = createClient({\n auth: AppStrategy({\n appId: 'MY-APP-ID',\n publicKey: 'YOUR_APP_PUBLIC_KEY',\n }),\n modules: {\n proGallery,\n },\n});\n\nwixClient.proGallery.onGalleryUpdated((event) => {\n // handle your event here\n});"}],"returnType":{"kind":"PRIMITIVE","name":"void"},"permissionIds":["PRO_GALLERY.READ"],"permissions":["Manage Galleries","Read Galleries"],"permissionsScopesIds":["SCOPE.DC-PROGALLERY.MANAGE-GALLERIES","SCOPE.DC-PROGALLERY.READ-GALLERIES"],"eventType":"wix.pro_gallery.gallery_v2_updated","permissionScopes":[{"name":"Manage Galleries","scopeId":"SCOPE.DC-PROGALLERY.MANAGE-GALLERIES"},{"name":"Read Galleries","scopeId":"SCOPE.DC-PROGALLERY.READ-GALLERIES"}]}],"articles":[{"content":"---\ntitle: Introduction\n---\n# About Pro Gallery\n\nThe Pro Gallery API allows you to manage pro galleries on a Wix site's backend.\n\nWith the Pro Gallery API, you can:\n\n+ Get, list, and update pro galleries created by a Wix site owner with the Editor.\n+ Get, list, create, update, and delete items in a pro gallery.\n+ Create or delete a pro gallery on a site's backend.\n\nFor the Pro Gallery API to synchronize with a site's frontend, a Wix site owner needs to [add a pro gallery](https://support.wix.com/en/article/wix-pro-gallery-adding-and-setting-up-your-gallery) to their site using the Editor. When you use the Pro Gallery API to create, update, or delete an item from a pro gallery created with the Editor, or to delete a pro gallery, the site's frontend updates automatically.\n\n> **Note:** We do not recommend creating new pro galleries using the Pro Gallery API.\n> When a Wix site owner adds a pro gallery to their site using the Editor, a corresponding pro gallery is created on the site's backend.\n> You can then use the Pro Gallery API to manage items in this pro gallery or delete it, and all updates are reflected on the site's frontend.\n> However, when you create a pro gallery using the Pro Gallery API, it's available only on the site's backend and doesn't appear on the live site.\n> In order to display a backend pro gallery on a live site, the site owner needs to connect it manually to a gallery component using code.\n> To learn more about how a site owner can do this using Velo, see [Displaying a Pro Gallery on Your Site Using the Pro Gallery Backend API](https://support.wix.com/en/article/velo-tutorial-displaying-a-pro-gallery-on-your-site-using-the-pro-gallery-backend-api).\n\n## Before you begin\n\nIt's important to note the following points before starting to code:\n\n+ We recommend using the Pro Gallery API for managing pro galleries that the site owner already created using the Editor.\n+ Read more about how site owners can manage their [Pro Galleries](https://support.wix.com/en/article/wix-pro-gallery-about-the-wix-pro-gallery).\n+ The [`onGalleryCreated()`](/pro-gallery/on-gallery-created) and [`onGalleryUpdated()`](/pro-gallery/on-gallery-updated) webhooks don't return the media items included in the gallery. To retrieve these items or their IDs, listen to the [`onGalleryItemCreated()`](/pro-gallery/on-gallery-item-created) and [`onGalleryItemUpdated()`](/pro-gallery/on-gallery-item-updated) webhooks.\n\n## Terminology\n\n+ **Pro Gallery:** A responsive and customizable gallery that displays media items.\n+ **Gallery Items:** Media items in a pro gallery, such as images, videos, and text files. You can read more about [supported media](https://support.wix.com/en/article/wix-pro-gallery-adding-media-to-the-gallery). \n","displayName":"Introduction","slugifyName":"introduction"},{"content":"To use the ProGallery API, install the `@wix/pro-gallery` package using npm or Yarn:\n ```console\nnpm install @wix/pro-gallery\n```\n\nor\n\n```console\nyarn add @wix/pro-gallery\n```\n\nThen import `{ proGallery }` from `@wix/pro-gallery`:\n\n```js\nimport { proGallery } from '@wix/pro-gallery'\n```\n ","displayName":"Setup","slugifyName":"setup"}],"builderTypes":[],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.0"}}