box_metadata_update_instance_on_file_tool
Update metadata on a file using its ID and template key. Specify metadata changes and optionally remove non-included data fields. Returns the Box API response.
Instructions
Update a metadata instance on a file.
Args: ctx (Context): The context object containing the request and lifespan context. file_id (str): The ID of the file to update the metadata on. template_key (str): The key of the metadata template. metadata (dict): The metadata to update. remove_non_included_data (bool): If True, remove data from fields not included in the metadata.
Returns: dict: The response from the Box API after updating the metadata.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file_id | Yes | ||
| metadata | Yes | ||
| remove_non_included_data | No | ||
| template_key | Yes |
Input Schema (JSON Schema)
{
"properties": {
"file_id": {
"title": "File Id",
"type": "string"
},
"metadata": {
"additionalProperties": true,
"title": "Metadata",
"type": "object"
},
"remove_non_included_data": {
"default": false,
"title": "Remove Non Included Data",
"type": "boolean"
},
"template_key": {
"title": "Template Key",
"type": "string"
}
},
"required": [
"file_id",
"template_key",
"metadata"
],
"title": "box_metadata_update_instance_on_file_toolArguments",
"type": "object"
}