The Pro Gallery API allows you to manage pro galleries on a Wix site's backend.
With the Pro Gallery API, you can:
For the Pro Gallery API to synchronize with a site's frontend, a Wix site owner needs to add a pro 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.
Note: We do not recommend creating new pro galleries using the Pro Gallery API. 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. 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. 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. 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. 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.
It's important to note the following points before starting to code:
This article shares some possible use cases for your app, as well as an example flow that could support each one. You're certainly not limited to these use cases, but they can be a helpful jumping-off point as you plan your app's implementation.
Your app can help the site owners upload media from a Pro Gallery to an external Social Media platform to increase their brand's popularity. You could retrieve the site's Pro Galleries, let the site owner select one, get the relevant media, and then upload the media items to the external platform.
Note: Make sure to include both the Wix media item IDs and the external media IDs in the mapping.
First, your app needs to create a mapping between the Wix media items and the external media. You can read about a possible way to do so in the Share a Pro Gallery on an External Platform example flow.
Note: Ignore the resulting webhook, so you don’t create an endless loop of updates.
This article describes the Wix Pro Gallery fields you can search and aggregate on a site.
To search or aggregate Wix Pro Gallery items on a site, set the search API documentType
parameter to PROGALLERY_ITEM
.
Description: Document type that was searched. In this case, PROGALLERY_ITEM
.
Type: String
Can search the content of this field: No
Can facet: No
Can sort: No
Can filter: No
Description: The ID of the pro gallery item.
Type: String
Can search the content of this field: No
Can facet: No
Can sort: No
Can filter: No
Description: Post title.
Type: String
Can search the content of this field: Yes
Can facet: No
Can sort: No
Can filter: in, eq, ne, gt, ge, lt, le
Description: Text of the post or comment.
Type: String
Can search the content of this field: Yes
Can facet: No
Can sort: No
Can filter: No
Description: Whether the gallery item is a video.
Type: Boolean
Can search the content of this field: No
Can facet: No
Can sort: No
Can filter: eq, ne, exists
Gallery ID.
Gallery name.
Total number of items in the gallery.
Media items in the gallery.
Index that determines which position a gallery is displayed on the site.
Note: If you assign the same sort order index to more than one gallery, the function fails.
Date and time the gallery was created.
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of galleries.
Maximum number of media items to return.
Min: 1
Max: 100
Default: 10
Number of galleries to skip in the response.
Default: 0
Maximum number of galleries to return.
Min: 1
Max: 10
Default: 10
Total number of galleries in the site.
List of galleries. Sorted by createdDate
.
curl -X GET \
'https://www.wixapis.com/progallery/v2/galleries' \
-H 'Authorization: <AUTH>'
{
"totalGalleriesCount": 1,
"gallery": [
{
"id": "e481d9b4-14b9-4a98-ae52-67f4170e3a63",
"totalItems": 2,
"items": [
{
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446,
"altText": "Some Alt",
"filename": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg"
}
},
"createdDate": "2022-02-08T10:59:29Z",
"tags": {
"values": ["image"]
}
},
{
"id": "17c786c6-5d5d-4271-995a-02d007809064",
"sortOrder": 1642505672333,
"title": "Video",
"description": "Video description",
"type": "VIDEO",
"video": {
"type": "YOUTUBE",
"videoInfo": {
"id": "",
"resolutions": [
{
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"height": 0,
"width": 0,
"format": "Youtube",
"quality": null,
"filename": null
}
],
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"posters": [
{
"id": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"url": "https://static.wixstatic.com/media/468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"height": 720,
"width": 1280,
"altText": null,
"urlExpirationDate": null,
"filename": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"sizeInBytes": null
}
]
}
},
"createdDate": "2022-01-18T11:34:34Z"
},
{
"id": "975a57a1-eccd-4e28-aac5-265be4dbb4f8",
"sortOrder": 1646212412985,
"title": "Mountainous Landscape",
"description": "Mountainous Landscape Description",
"type": "VIDEO",
"video": {
"type": "WIX_MEDIA",
"videoInfo": {
"id": "11062b_20125b6ebe434abd96c4d7773634d1db",
"resolutions": [
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/480p/mp4/file.mp4",
"height": 480,
"width": 854,
"format": "mp4",
"quality": "480p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/720p/mp4/file.mp4",
"height": 720,
"width": 1280,
"format": "mp4",
"quality": "720p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"height": 1080,
"width": 1920,
"format": "mp4",
"quality": "1080p"
}
],
"filename": "11062b_20125b6ebe434abd96c4d7773634d1db",
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"posters": [
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg"
}
]
},
"duration": "20000"
},
"createdDate": "2022-03-02T09:13:33Z"
}
],
"createdDate": "2020-08-04T10:01:50Z"
}
]
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a new gallery.
Note: When you create a new gallery with Create Gallery, the newly-created gallery is available only on a site's backend and doesn't appear on the live site. To display a backend gallery on a live site, the site owner needs to connect it manually to a gallery component. 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.
You can create an entirely new gallery, or clone an existing gallery using the cloneFromGalleryId
parameter.
When a gallery is cloned, the newly-created gallery includes the same properties as the existing gallery except for the gallery IDs, item IDs, sort order, and created and updated dates.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery to create.
Gallery ID to clone from.
Created gallery.
curl -X POST \
'https://www.wixapis.com/progallery/v2/galleries' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"gallery": {
"name": "Simple Gallery",
"items": [
{
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
}
}
]
}
}'
{
"gallery": {
"id": "a59d43f0-0023-4ef2-8593-e38d2b668795",
"name": "Simple Gallery",
"totalItems": 1,
"items": [
{
"id": "1ee25150-8271-41b2-9601-6befea43fb7a",
"mediaUrl": "https://static.wixstatic.com/media/8bb438_3ae04589aef4480e89a24d7283c69798~mv2_d_2869_3586_s_4_2.jpg",
"sortOrder": 1563813116.8060222,
"fileName": "002cd4_2d48efc3227e47b3945a682eac7f3ae1_",
"title": "I'm an image title",
"description": "Describe your image here.",
"dataType": "PHOTO",
"photoMetadata": {
"width": 2869,
"height": 3586
},
"createdDate": "2020-08-17T14:10:55.486Z",
"updatedDate": "2020-08-17T14:10:55.486Z",
"tags": {}
}
],
"createdDate": "2020-08-17T14:10:55.483Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Gets a gallery by ID.
Gallery ID.
Number of media items to skip in the response.
Default: 0
Maximum number of media items to return.
Min: 1
Max: 100
Default: 50
Returned gallery.
curl -X GET \
'https://www.wixapis.com/progallery/v2/galleries/432c362d-1440-4205-b9cb-35ea11a22682?offset=1&limit=3' \
-H 'Authorization: <AUTH>'
{
"gallery": {
"id": "432c362d-1440-4205-b9cb-35ea11a22682",
"totalItems": 3,
"items": [
{
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446,
"altText": "Some Alt",
"filename": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg"
}
},
"createdDate": "2022-02-08T10:59:29Z",
"tags": {
"values": ["image"]
}
},
{
"id": "17c786c6-5d5d-4271-995a-02d007809064",
"sortOrder": 1642505672333,
"title": "Video",
"description": "Video description",
"type": "VIDEO",
"video": {
"type": "YOUTUBE",
"videoInfo": {
"id": "",
"resolutions": [
{
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"height": 0,
"width": 0,
"format": "Youtube",
"quality": null,
"filename": null
}
],
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"posters": [
{
"id": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"url": "https://static.wixstatic.com/media/468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"height": 720,
"width": 1280,
"altText": null,
"urlExpirationDate": null,
"filename": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"sizeInBytes": null
}
]
}
},
"createdDate": "2022-01-18T11:34:34Z"
},
{
"id": "975a57a1-eccd-4e28-aac5-265be4dbb4f8",
"sortOrder": 1646212412985,
"title": "Mountainous Landscape",
"description": "Mountainous Landscape Description",
"type": "VIDEO",
"video": {
"type": "WIX_MEDIA",
"videoInfo": {
"id": "11062b_20125b6ebe434abd96c4d7773634d1db",
"resolutions": [
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/480p/mp4/file.mp4",
"height": 480,
"width": 854,
"format": "mp4",
"quality": "480p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/720p/mp4/file.mp4",
"height": 720,
"width": 1280,
"format": "mp4",
"quality": "720p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"height": 1080,
"width": 1920,
"format": "mp4",
"quality": "1080p"
}
],
"filename": "11062b_20125b6ebe434abd96c4d7773634d1db",
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"posters": [
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg"
}
]
},
"duration": "20000"
},
"createdDate": "2022-03-02T09:13:33Z"
}
]
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a gallery.
Notes:
You can only call this method when authenticated as a Wix app or Wix user identity.
ID of the gallery to delete.
ID of the deleted gallery.
curl -X DELETE \
'https://www.wixapis.com/progallery/v2/galleries/c68c0dc5-088f-4205-b202-3eef797ea0ab' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"galleryId": "c68c0dc5-088f-4205-b202-3eef797ea0ab"
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of media items in a specified gallery.
Gallery ID.
Number of media items to skip in the response.
Default: 0
Maximum number of media items to return.
Min: 1
Max: 100
Default: 50
List of media items in the gallery.
curl -X GET \
'https://www.wixapis.com/progallery/v2/galleries/e481d9b4-14b9-4a98-ae52-67f4170e3a63/items' \
-H 'Authorization: <AUTH>'
{
"items": [
{
"id": "534264c7-0c61-45ce-b414-891aacadf4c2",
"sortOrder": 1657439075188,
"title": "Text Item 1",
"description": "This is a text item in my gallery.",
"type": "TEXT",
"text": {
"html": "\n <div class=\"te-pro-gallery-text-item\"\n style=\"padding: 30px;\n width: 420px;\n height: 420px;\n background-color: rgba(232, 230, 230, 0.7);\n transform-style: preserve-3d;\n overflow: hidden;\n word-wrap: break-word;\n font-style: normal; font-weight:normal;\n \">\n <div style=\"\n position: relative;\n top: 50%;\n transform: translateY(-50%);\">\n <p style=\"text-align:center\"><span style=\"color:#d2f6de;\"><span style=\"font-size:50px\">woohoo</span></span></p>\n\n </div>\n </div>",
"css": {
"backgroundColor": "rgba(232, 230, 230, 0.7)",
"googleFonts": [],
"height": 420,
"textVerticalAlignment": "middle",
"canvasLayout": "square",
"ratio": -50,
"padding": 30,
"width": 420
}
},
"createdDate": "2021-03-30T15:23:22Z"
},
{
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446,
"altText": "Some Alt",
"filename": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg"
}
},
"createdDate": "2022-02-08T10:59:29Z",
"tags": {
"values": ["image"]
}
},
{
"id": "17c786c6-5d5d-4271-995a-02d007809064",
"sortOrder": 1642505672333,
"title": "Video",
"description": "Video description",
"type": "VIDEO",
"video": {
"type": "YOUTUBE",
"videoInfo": {
"id": "",
"resolutions": [
{
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"height": 0,
"width": 0,
"format": "Youtube",
"quality": null,
"filename": null
}
],
"url": "https://www.youtube.com/watch?v=NCtzkaL2t_Y&ab_channel=TheBeatlesVEVO",
"posters": [
{
"id": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"url": "https://static.wixstatic.com/media/468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"height": 720,
"width": 1280,
"altText": null,
"urlExpirationDate": null,
"filename": "468ec5_347f032da9a04e5b9c03ad2a14a07b52~mv2.jpg",
"sizeInBytes": null
}
]
}
},
"createdDate": "2022-01-18T11:34:34Z"
},
{
"id": "975a57a1-eccd-4e28-aac5-265be4dbb4f8",
"sortOrder": 1646212412985,
"title": "Mountainous Landscape",
"description": "Mountainous Landscape Description",
"type": "VIDEO",
"video": {
"type": "WIX_MEDIA",
"videoInfo": {
"id": "11062b_20125b6ebe434abd96c4d7773634d1db",
"resolutions": [
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/480p/mp4/file.mp4",
"height": 480,
"width": 854,
"format": "mp4",
"quality": "480p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/720p/mp4/file.mp4",
"height": 720,
"width": 1280,
"format": "mp4",
"quality": "720p"
},
{
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"height": 1080,
"width": 1920,
"format": "mp4",
"quality": "1080p"
}
],
"filename": "11062b_20125b6ebe434abd96c4d7773634d1db",
"url": "https://video.wixstatic.com/video/11062b_20125b6ebe434abd96c4d7773634d1db/1080p/mp4/file.mp4",
"posters": [
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf000.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf001.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf002.jpg"
},
{
"id": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"url": "https://static.wixstatic.com/media/11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg",
"height": 2160,
"width": 3840,
"filename": "11062b_20125b6ebe434abd96c4d7773634d1dbf003.jpg"
}
]
},
"duration": "20000"
},
"createdDate": "2022-03-02T09:13:33Z"
}
]
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Creates a media item in a specified gallery.
Note: When creating or updating image items in a pro gallery, the images must be uploaded or imported to the Wix Media Manager first, as the imageInfo
parameter currently only supports the Wix Media URL.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
Media item to create.
Created media item.
curl -X POST \
'https://www.wixapis.com/progallery/v2/galleries/e481d9b4-14b9-4a98-ae52-67f4170e3a63/items' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"item": {
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
}
}
}'
{
"item": {
"id": "3bd99e6f-0d1a-4a97-a7dc-a57a5257a6a8",
"mediaUrl": "https://static.wixstatic.com/media/nsplsh_7157426736346c6e443551~mv2.jpg",
"sortOrder": 1597671468.749,
"fileName": "Image by Savannah Rohleder",
"title": "Image by Savannah Rohleder",
"dataType": "PHOTO",
"photoMetadata": {
"width": 3265,
"height": 4898
},
"createdDate": "2020-08-17T13:40:38.147Z",
"updatedDate": "2020-08-17T13:40:38.147Z",
"tags": {
"tags": ["_unsplash", "_unsplash_qWBg64lnD5Q"]
}
}
}
This method has been replaced with Bulk Delete Gallery Items, and will be removed on August 15, 2024.
Deletes multiple media items from a gallery.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
ID of the media item to delete.
Gallery that previously included the deleted media item.
curl -X DELETE \
'https://www.wixapis.com/progallery/v2/galleries/432c362d-1440-4205-b9cb-35ea11a22682/items' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"itemIds": [
"fa499c86-aee9-11ea-8c85-12879e2400f0",
"cb499c86-aee9-11ea-8c85-12879e2400f0"
]
}'
{
"gallery": {
"id": "a59d43f0-0023-4ef2-8593-e38d2b668795",
"name": "Simple Gallery",
"totalItems": 1,
"items": [],
"createdDate": "2020-08-17T14:10:55.483Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Gets a gallery item by ID.
Gallery ID.
Item ID.
Returned media item.
curl -X GET \
'https://www.wixapis.com/progallery/v2/galleries/432c362d-1440-4205-b9cb-35ea11a22682/items/fa4ab052-aee9-11ea-8c85-12879e2400f0' \
-H 'Authorization: <AUTH>'
{
"item": {
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446,
"altText": "Some Alt",
"filename": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg"
}
},
"createdDate": "2022-02-08T10:59:29Z",
"tags": {
"values": ["image"]
}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes a media item from a gallery.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
ID of the media item to delete.
ID of the deleted media item.
curl -X DELETE \
'https://www.wixapis.com/progallery/v2/galleries/432c362d-1440-4205-b9cb-35ea11a22682/items/fa499c86-aee9-11ea-8c85-12879e2400f0' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>'
{
"itemId": "fa499c86-aee9-11ea-8c85-12879e2400f0"
}
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.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
Gallery to update.
Updated gallery.
curl -X PUT \
'https://www.wixapis.com/progallery/v2/galleries/a59d43f0-0023-4ef2-8593-e38d2b668795' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"gallery": {
"name": "Partially Updated Gallery123"
}
}'
{
"gallery": {
"id": "a59d43f0-0023-4ef2-8593-e38d2b668795",
"name": "Partially Updated Gallery123",
"totalItems": 1,
"items": [
{
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
}
}
],
"createdDate": "2020-08-17T14:33:56.205Z"
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Deletes multiple media items from a gallery.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
IDs of the media items to delete.
IDs of the deleted media items.
curl -X POST \
'https://www.wixapis.com/progallery/v2/galleries/432c362d-1440-4205-b9cb-35ea11a22682/items/delete' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"itemIds": [
"fa499c86-aee9-11ea-8c85-12879e2400f0",
"cb499c86-aee9-11ea-8c85-12879e2400f0"
],
}'
{
"itemIds": [
"fa499c86-aee9-11ea-8c85-12879e2400f0",
"cb499c86-aee9-11ea-8c85-12879e2400f0"
]
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Updates a media item in a specified gallery.
Note: When creating or updating image items in a pro gallery, the images must be uploaded or imported to the Wix Media Manager first, as the imageInfo
parameter currently only supports the Wix Media URL.
You can only call this method when authenticated as a Wix app or Wix user identity.
Gallery ID.
Item ID.
Media item to update.
Updated media item.
curl -X PATCH \
'https://www.wixapis.com/progallery/v2/galleries/2113aed5-8ebd-418a-a60b-74a799ce50e0/items/d02bd19a-c0a3-456a-9c82-32c08ceb6712' \
-H 'Content-Type: application/json' \
-H 'Authorization: <AUTH>' \
-d '{
"item": {
"title": "Newly Updated Item1",
"description": "Describe your image here1."
}
}'
{
"item": {
"id": "d02bd19a-c0a3-456a-9c82-32c08ceb6712",
"sortOrder": 1563813116.8060222,
"title": "Newly Updated Item1",
"description": "Describe your image here.",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
},
"createdDate": "2020-08-17T13:33:45Z",
"updatedDate": "2020-08-17T15:13:12Z",
"tags": {}
}
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a gallery is created.
Note: The event data doesn't include gallery items or their IDs. To receive information about the created items you need to listen to the Gallery Item Created webhook.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "0857b764-afc8-4ac1-9c2d-e44588491bd1",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "created",
"entityId": "d5c2b82e-4214-49ac-85ea-80add7ebf79d",
"createdEvent": {
"entity": {
"id": "d5c2b82e-4214-49ac-85ea-80add7ebf79d",
"name": "gallery",
"totalItems": 0,
"items": [],
"createdDate": "2021-12-16T11:45:16Z"
}
},
"eventTime": "2021-12-16T11:45:16.479817Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a gallery is updated.
Note: The event data doesn't include gallery items or their IDs. To receive information about the updated items you need to listen to the Gallery Item Updated webhook.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "a76ec8a5-981d-44b5-b77a-8cef109ea6d4",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "updated",
"entityId": "73cbf7b0-8c45-4b17-972b-31741af61064",
"updatedEvent": {
"currentEntity": {
"id": "73cbf7b0-8c45-4b17-972b-31741af61064",
"name": "gallery",
"totalItems": 12,
"items": [],
"createdDate": "2021-12-16T11:41:11Z"
}
},
"eventTime": "2021-12-16T11:41:11.610931Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a gallery is deleted.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "e6c848c6-1916-4138-8d96-635cc86a8f4d",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "deleted",
"entityId": "1b57a7fd-77cd-488c-a754-b3129ef55214",
"deletedEvent": {},
"eventTime": "2021-12-16T11:36:23.307451Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a media item in a specified gallery is created.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected gallery_item_created
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_gallery_item_created",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "5844370e-50a1-4e71-8763-e27778ced7b3",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "gallery_item_created",
"entityId": "4937b26c-b9d3-4c43-b772-f1f3ba840b3d",
"actionEvent": {
"body": {
"item": {
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
}
}
}
},
"eventTime": "2021-12-16T12:28:44.905701Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a media item in a specified gallery is updated.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected gallery_item_updated
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_gallery_item_updated",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "d95986ad-f137-4b20-900e-066c4ab02c90",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "gallery_item_updated",
"entityId": "4937b26c-b9d3-4c43-b772-f1f3ba840b3d",
"actionEvent": {
"body": {
"updatedItem": {
"id": "a045b201-ee7d-447c-b0c3-746cba83253c",
"sortOrder": 1644317968.985,
"title": "Some Title",
"description": "Some Description",
"type": "IMAGE",
"image": {
"type": "WIX_MEDIA",
"imageInfo": {
"id": "11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"url": "https://static.wixstatic.com/media/11062b_12703ed9a6574547bcaed22b1ce44eef~mv2.jpeg",
"height": 4298,
"width": 6446
},
"focalPoint": {
"x": 0.5,
"y": 0.5
}
}
}
}
},
"eventTime": "2021-12-16T12:32:37.513965Z",
"triggeredByAnonymizeRequest": false
}
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Triggered when a media item in a specified gallery is deleted.
Note: The event is triggered when a gallery item is deleted individually and when a gallery item is deleted because its gallery is deleted.
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.
Unique event ID. Allows clients to ignore duplicate webhooks.
Fully qualified domain name of the entity associated with the event. Expected wix.pro_gallery.gallery_v2
.
Event name. Expected gallery_item_deleted
.
ID of the entity associated with the event.
Event timestamp.
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).
If present, indicates the action that triggered the event.
Event information.
The data payload will include the following as an encoded JWT:
{
"data": {
"eventType": "wix.pro_gallery.gallery_v2_gallery_item_deleted",
"instanceId": "<app-instance-id>",
"data": "<stringified-JSON>",
// The identity field is sent as a stringified JSON
"identity": {
"identityType": "<identityType>", // ANONYMOUS_VISITOR, MEMBER, WIX_USER, APP
"anonymousVisitorId": "<anonymousVisitorId>", // in case of ANONYMOUS_VISITOR
"memberId": "<memberId>", // in case of MEMBER
"wixUserId": "<wixUserId>", // in case of WIX_USER
"appId": "<appId>" // in case of APP
}
}
}
{
"id": "54ce2850-97fa-45d4-8100-78a8526b9534",
"entityFqdn": "wix.pro_gallery.v2.gallery",
"slug": "gallery_item_deleted",
"entityId": "4937b26c-b9d3-4c43-b772-f1f3ba840b3d",
"actionEvent": {
"body": {
"itemId": "5e8a7d5e-532f-4132-8b35-e6c5dd98f9e8"
}
},
"eventTime": "2021-12-16T12:36:29.316454Z",
"triggeredByAnonymizeRequest": false,
"originatedFrom": "Gallery Deleted"
}