Create Folder

POST 
/medias/folder

Creates a new folder in the media storage

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

altIdstringrequired

Location Id

altTypestringrequired
Type of entity (location only)
Available optionslocation
namestringrequired

Name of the folder to be created

parentIdstring

ID of the parent folder (optional)

Example (auto)

{
  "altId": "sx6wyHhbFdRXh302LLNR",
  "altType": "location",
  "name": "New Folder",
  "parentId": "64af50c42d567a3b4f5989e0"
}

application/json

Returns the newly created folder object

application/json

Schema

Schema

altIdstringrequired

Location identifier that owns this folder

altTypestringrequired
Type of entity that owns the folder
Available optionslocation
namestringrequired

Name of the folder

parentIdstring

ID of the parent folder (null for root folders)

typestringrequired

Type of the object (always 'folder' for folders)

deletedboolean

Whether the folder has been deleted

pendingUploadboolean

Whether there are pending uploads to this folder

categorystring

Primary category of content stored in the folder

subCategorystring

Sub-category of content stored in the folder

isPrivateboolean

Whether the folder is private and not publicly accessible

relocatedFolderboolean

Whether the folder has been moved from its original location

migrationCompletedboolean

Whether the data migration process has been completed for this folder

appFolderboolean

Whether this is a system-generated application folder

isEssentialboolean

Whether the folder is essential and should not be deleted

statusstring

Current status of the folder

lastUpdatedBystring

ID of the user who last updated the folder

Example (auto)

{
  "altId": "sx6wyHhbFdRXh302LLNR",
  "altType": "location",
  "name": "New Folder",
  "parentId": "64af50c42d567a3b4f5989e0",
  "type": "folder",
  "deleted": false,
  "pendingUpload": false,
  "category": "image",
  "subCategory": "logo",
  "isPrivate": false,
  "relocatedFolder": false,
  "migrationCompleted": true,
  "appFolder": false,
  "isEssential": false,
  "status": "string",
  "lastUpdatedBy": "user-uuid-123"
}