Update file metadata
update_metadataUpdate a drive file's metadata (category, description, project) and tags by its storage ID. Use merge to keep omitted fields or replace to clear them; confirm=true applies the changes.
Instructions
Update a file's metadata (category / description / project) and tags in a drive, addressed by its storage id (the StorageId field from search_files / browse_folder / get_file_metadata — not from list_files or recent_files, whose ids are a different id space and will NOT work). Defaults to mode "merge": a metadata field you do not send is KEPT, a field sent as "" is CLEARED, and tags are merged by Key — a tag with the same Key is overwritten and tags with other Keys are kept. Destructive cases: sending tags: [] CLEARS every tag on the object, and mode "replace" clears every metadata field and every tag you do not send — that is also the only way to remove a single tag, by sending the complete set you want to keep. Requires the drive (bucketName) and confirm=true. Note: the update rewrites the object in place (S3 copy) — its ETag changes (and may change format) and LastModified is set to the update time; ETag-keyed caches and sync tools will see the object as new. Objects larger than 5 GiB are updated via multipart copy; objects larger than 8 GiB are rejected, because the rewrite cannot finish inside the API request timeout. (Write access is authorized server-side by the public API's RBAC — a denial means the API key lacks this tool's scope, not a tool failure.)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | merge (default): metadata keys you omit are KEPT, a key sent as "" is CLEARED, and tags are merged by Key — a tag with the same Key is overwritten, others are kept. replace: every metadata field and every tag you do not send is CLEARED. Use replace to remove a single tag (send the complete set you want to keep). | |
| tags | No | Tags to apply. Under the default merge mode they are merged by Key — a tag with the same Key is overwritten and tags with other Keys are kept; under replace they become the COMPLETE tag set. Sending [] CLEARS every tag in both modes, and leaving this out keeps the existing tags under merge (clears them under replace). | |
| confirm | No | Must be true to actually perform this mutating/irreversible action. If omitted or false, the tool returns a preview and makes no changes. | |
| metadata | No | Metadata fields to set. Under the default merge mode a field you leave out is KEPT and a field sent as "" is CLEARED; under replace every field you leave out is CLEARED. | |
| storageId | Yes | Storage/index id of the object — the StorageId field returned by search_files, browse_folder, or get_file_metadata. NOTE: the ids from list_files and recent_files belong to a different id space and will NOT work here. | |
| bucketName | No | The CloudSee drive (S3 bucket) name to operate in, e.g. 'max-2778abc0' — find it in the CloudSee dashboard. Required unless CLOUDSEE_DEFAULT_BUCKET is configured on the server. |