HighLevel: Medias schemas

← Medias operations · All schemas

Bulk Delete Trash Files or Folders — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location identifier
altType	string	Required within parent	Type of entity that owns the files One of: location
filesToBeDeleted	array	Required within parent	Array of file objects to be deleted or trashed
filesToBeDeleted[]	Model	Each item	Expand Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item
status	string	Required within parent	Status to set for the files (deleted or trashed) One of: deleted, trashed

Referenced models: Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item

Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Unique identifier of the file or folder to be deleted

Bulk Update Files Folders — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location identifier
altType	string	Required within parent	Type of entity that owns the files One of: location
filesToBeUpdated	array	Required within parent	Array of file objects to be updated
filesToBeUpdated[]	Model	Each item	Expand Bulk Update Files Folders — request body — body files To Be Updated item

Referenced models: Bulk Update Files Folders — request body — body files To Be Updated item

Bulk Update Files Folders — request body — body files To Be Updated item

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier of the file or folder to be updated
name	string	Optional	New name for the file or folder

Create Folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	Type of entity (location only) One of: location
name	string	Required within parent	Name of the folder to be created
parentId	string	Optional	ID of the parent folder (optional)

Create Folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location identifier that owns this folder
altType	string	Required within parent	Type of entity that owns the folder Known values: location
appFolder	boolean	Optional	Whether this is a system-generated application folder
category	string	Optional	Primary category of content stored in the folder
deleted	boolean	Optional	Whether the folder has been deleted
isEssential	boolean	Optional	Whether the folder is essential and should not be deleted
isPrivate	boolean	Optional	Whether the folder is private and not publicly accessible
lastUpdatedBy	string	Optional	ID of the user who last updated the folder
migrationCompleted	boolean	Optional	Whether the data migration process has been completed for this folder
name	string	Required within parent	Name of the folder
parentId	string	Optional	ID of the parent folder (null for root folders)
pendingUpload	boolean	Optional	Whether there are pending uploads to this folder
relocatedFolder	boolean	Optional	Whether the folder has been moved from its original location
status	string	Optional	Current status of the folder
subCategory	string	Optional	Sub-category of content stored in the folder
type	string	Required within parent	Type of the object (always 'folder' for folders)

Get List of Files Folders — response body

Field	Type	Presence	Description and constraints
$	object	Root
files	array	Required within parent	Array of File Objects
files[]	string	Each item

Update File Folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location identifier that owns the file or folder
altType	string	Required within parent	Type of entity that owns the file or folder One of: location
name	string	Required within parent	New name for the file or folder

Upload File into Media Storage — response body

Field	Type	Presence	Description and constraints
$	object	Root
fileId	string	Required within parent	ID of the uploaded file
url	string	Required within parent	Google Cloud Storage URL of the uploaded file