Tasks
Update File Info (Bulk)
Updates visibility or archived status of multiple files. Useful for managing file access and organization in bulk.
Basic usage
Archive all PDF files.
Advanced usage
Archive all public images uploaded before 2024.
Parameters
filters required object
The filters used to determine which files will be updated.
Show child attributes
search string
Search by filename.
content_type string
Filter by MIME type. Partial matches such as image/ are supported.
size_min string
Minimum file size.
size_max string
Maximum file size.
upload_date object
Filter by upload date.
Show child attributes
from string
Start date for filtering by upload date.
to string
End date for filtering by upload date.
access_date object
Filter by last access date.
Show child attributes
from string
Start date for filtering by last access date.
to string
End date for filtering by last access date.
visibility string
Filter by file visibility.
Options: private public
archived boolean
Only return archived files.
deleted boolean
Only return deleted files.
dry_run boolean
When true, returns the files that would be updated without applying any changes.
Defaults to true since this task can potentially update a large number of files. Set to false to apply the changes.
Default: true
update_data required object
The updates to apply to all matching files.
Show child attributes
visibility string
The visibility of the file.
Options: private public
__archived boolean
Whether the file should be archived.
Properties
matched_count number
The number of files matching the supplied filters.
update_data object
The final database operation applied to matching files, including additional operators applied by the system.
query object
The final query that would have been used to find matching files, including additional filters applied by the system.
Only returned when dry_run is set to true.
modified_count number
The number of files that were actually modified by the update operation.
Only returned when dry_run is set to false.