deleteGallery( )

Developer Preview

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.

When a gallery is deleted, the deleted gallery is no longer returned when calling the listGalleries() function.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Galleries
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
galleryIdstringRequired

ID of the gallery to delete.

optionsDeleteGalleryOptions
Returns
Return Type:Promise<DeleteGalleryResponse>
Was this helpful?
Yes
No