Folder Object

Attributes
idstringmaxLength 100
Folder ID. Generated when a folder is created in the Media Manager.

displayNamestringmaxLength 256
Folder name as it appears in the Media Manager.

parentFolderIdstringmaxLength 100
ID of the folder's parent folder.
Default: media-root folder.

createdDatestringRead-onlyformat date-time
Date the folder was created.

updatedDatestringRead-onlyformat date-time
Date the folder was updated.

statestringRead-only
2 supported values:
OKDELETED
State of the folder.
Was this helpful?
Yes
No

GetList Folders

Retrieves a list of folders in the Media Manager. To retrieve a list of folders within a specific folder in the Media Manager, pass the specific folder's ID in the parentFolderId parameter. If no folder is specified, the endpoint retrieves a list of folders within the root folder of the Media Manager.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/site-media/v1/folders

Was this helpful?
Yes
No

PostCreate Folder

Creates a new folder in the Media Manager.

Use the parentFolderId parameter to specify in which existing folder you want the new folder to be created. If no folder is specified, the new folder is created in the media-root folder.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/site-media/v1/folders

Was this helpful?
Yes
No

GetGet Folder

Gets information from a specific folder in the Media Manager.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/site-media/v1/folders/{folderId}

Was this helpful?
Yes
No

PostSearch Folders

Searches the Media Manager and returns a list of folders that match the terms specified in the parameters.

If no parameters are specified, the endpoint returns all folders in the MEDIA_ROOT folder.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/site-media/v1/folders/search

Was this helpful?
Yes
No

PatchUpdate Folder

Updates a folder.

You can use the parentFolderId parameter to move a folder from its current parent folder to a different parent folder.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
PATCH
https://www.wixapis.com/site-media/v1/folders/{folder.id}

Was this helpful?
Yes
No

PostGenerate Folder Download Url

Generates a URL for downloading a compressed file containing a specific folder in the Media Manager.

The compressed file can contain sub-folders, and up to 1000 files.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/site-media/v1/folders/{folderId}/generate-download-url

Was this helpful?
Yes
No

PostBulk Delete Folders

Temporarily deletes the specified folders from the Media Manager.

The deleted folders are moved to the Media Manager's trash-root folder (trash bin) unless permanently deleted. To permanently delete folders, pass the permanent parameter with the value true. Permanently deleting folders isn't reversible, so make sure that the files in these folders aren't being used in a site or in any other way as the files will no longer be accessible.

Note the following:

  • When a folder is deleted, the files in that folder are deleted.
  • The specified folders can be from different parent folders.
  • Moving multiple folders at once is an asynchronous action, and may take time for the changes to appear in the Media Manager.
  • Attempting to delete folders that are already in the trash bin doesn't result in an error.
  • If your site contains files from a deleted media folder, the files still appear on your site as the deleted folder is still in the Media Manager (in the trash bin).
  • You can use the Bulk Restore Folders From Trash Bin endpoint to restore folders from the Media Manager's trash bin.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/site-media/v1/bulk/folders/delete

Was this helpful?
Yes
No

PostBulk Restore Folders From Trash Bin

Restores the specified folders from the Media Manager's trash bin, and moves them to their original locations in the Media Manager.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
POST
https://www.wixapis.com/site-media/v1/bulk/trash-bin/folders/restore

Was this helpful?
Yes
No

GetList Deleted Folders

Retrieves a list of folders in the Media Manager's trash bin.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token
Endpoint
GET
https://www.wixapis.com/site-media/v1/trash-bin/folders

Was this helpful?
Yes
No

Folder Created

Triggered when a folder is created.

This event is also triggred when a folder is restored from the Media Manager's trash bin.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.media.site_media.v1.folder.

slugstring
Event name. Expected created.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

createdEventobject
Event information.
Was this helpful?
Yes
No

Folder Updated

Triggered when a folder is updated, including when a folder is moved to a different parent folder.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.media.site_media.v1.folder.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No

Folder Deleted

Triggered when a folder is deleted.

If the movedToTrash property in the event object is true, the folder was moved to the Media Manager's trash bin. If the movedToTrash property in the event object is false, the folder was permanently deleted.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings Services and Settings
Read Media Manager
Manage Media Manager
Learn more about permission scopes.
Event BodyEvent Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.media.site_media.v1.folder.

slugstring
Event name. Expected deleted.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

deletedEventstruct
Event information.
Was this helpful?
Yes
No