This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a gallery.
Only the fields in the gallery
object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
Important:
When updating image
items in your gallery, the images must be uploaded to the Wix Media Manager first as the imageInfo
parameter currently only supports the Wix media URL.
This function requires elevated permissions and runs only on the backend and on dashboard pages.
function updateGallery(
_id: string,
gallery: UpdateGallery,
options: UpdateGalleryOptions,
): Promise<Gallery>;
ID of the gallery to update.
The information for the gallery being updated.
import { proGallery } from "wix-pro-gallery-backend";
/* Sample _id value: '10874ccf-5867-4225-9550-3885079bad66'
*
* Sample gallery value:
* {
* "name": "New Name",
* "sortOrder": 420
* }
*/
export async function myUpdateGalleryFunction(_id, gallery) {
try {
const updatedGallery = await proGallery.updateGallery(_id, gallery);
const name = updatedGallery.name;
const sortOrder = updatedGallery.sortOrder;
console.log("Success! Updated the gallery:", updatedGallery);
return updatedGallery;
} catch (error) {
console.error(error);
// Handle the error
}
}
/* Promise resolves to:
* {
* "_createdDate": "Mon Feb 08 2021 13:44:37",
* "_id":"10874ccf-5867-4225-9550-3885079bad66",
* "items": [
* {
* "_createdDate": Tue Mar 30 2021 15:23:22,
* "_id": "534264c7-0c61-45ce-b414-891aacadf4c2",
* "_updatedDate": Tue Mar 30 2021 15:23:22,
* "description": "This is the first item in my gallery.",
* "sortOrder": 1657439075188
* "title": "Item 1"
* "type": "IMAGE",
* "image": {
* "imageInfo": "wix:image://v1/38939f9568z222d6avc6285c9ac1e9129.jpg/38939f9568z222d6avc6285c9ac1e9129.jpg#originWidth=200&originHeight=199"
* }
* },
* {
* "_createdDate": Sun Jul 03 2022 12:05:15,
* "_id": "4507a07b-ab93-4326-a222-6d0bd8da0625",
* "_updatedDate": Tues Jul 05 2022 10:25:45
* "description": "This is the second item in my gallery.",
* "sortOrder": 1857439076299
* "title": "Item 2"
* "type": "IMAGE",
* "image": {
* "imageInfo": "wix:image://v1/25139f9568b74d8aac6286c9ac1e8186.jpg/25139f9568b74d8aac6286c9ac1e8186.jpg#originWidth=4000&originHeight=2667"
* }
* }
* ],
* "name": "New Name",
* "sortOrder": "420",
* "totalItems": 2
* }
*/
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.