Default: media-root folder.
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:Syntax
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:Syntax
Gets information from a specific folder in the Media Manager.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
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:Syntax
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:Syntax
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:Syntax
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:Syntax
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:Syntax
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:Syntax
Triggered when a folder is created.
This event is also triggred when a folder is restored from the Media Manager's trash bin.
Event Body
Triggered when a folder is updated, including when a folder is moved to a different parent folder.
Event Body
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.