Box Developer Documentation
Log in

Remove metadata from an item

Guides Metadata Metadata instances Remove metadata from an item
Edit this page

Required Guides

Remove metadata from an item

To remove an instance of a metadata template assigned to a file or folder, use the item's id, and the template's templateKey and scope.

Metadata scopes can be either global for templates available to all enterprises, enterprise for templates available to the current enterprise, or the enterprise_:id for templates belonging to an enterprise whose ID is the :id value in the scope name.

Remove metadata from a file

To delete an instance of a metadata template from a file, call the DELETE /files/:file_id/metadata/:templateKey/schema API endpoint.

cURL
curl -i -X DELETE "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileMetadata.deleteFileMetadataById(
  file.id,
  'enterprise' as DeleteFileMetadataByIdScope,
  templateKey,
);
Python Gen
client.file_metadata.delete_file_metadata_by_id(
    file.id, DeleteFileMetadataByIdScope.ENTERPRISE, template_key
)
.NET Gen
await client.FileMetadata.DeleteFileMetadataByIdAsync(fileId: file.Id, scope: DeleteFileMetadataByIdScope.Enterprise, templateKey: templateKey);
Swift Gen (Beta)
try await client.fileMetadata.deleteFileMetadataById(fileId: file.id, scope: DeleteFileMetadataByIdScope.global, templateKey: "properties")
Java Gen (Beta)
client.getFileMetadata().deleteFileMetadataById(file.getId(), DeleteFileMetadataByIdScope.ENTERPRISE, templateKey)
Java
BoxFile file = new BoxFile(api, "id");
file.deleteMetadata("myMetadataTemplate");
Python
client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').delete()
.NET
await client.MetadataManager.DeleteFileMetadataAsync("11111", "enterprise", "marketingCollateral");
Node
client.files.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
	.then(() => {
		// removal succeeded — no value returned
	});;

This API returns a 204 No Content API response with no response body when the instance has been successfully removed from the file.

Remove metadata from a folder

To delete an instance of a metadata template, call the DELETE /folders/:folder_id/metadata/:templateKey/schema API endpoint.

cURL
curl -i -X DELETE "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.folderMetadata.deleteFolderMetadataById(
  folder.id,
  'enterprise' as DeleteFolderMetadataByIdScope,
  templateKey,
);
Python Gen
client.folder_metadata.delete_folder_metadata_by_id(
    folder.id, DeleteFolderMetadataByIdScope.ENTERPRISE, template_key
)
.NET Gen
await client.FolderMetadata.DeleteFolderMetadataByIdAsync(folderId: folder.Id, scope: DeleteFolderMetadataByIdScope.Enterprise, templateKey: templateKey);
Swift Gen (Beta)
try await client.folderMetadata.deleteFolderMetadataById(folderId: folder.id, scope: DeleteFolderMetadataByIdScope.global, templateKey: "properties")
Java Gen (Beta)
client.getFolderMetadata().deleteFolderMetadataById(folder.getId(), DeleteFolderMetadataByIdScope.ENTERPRISE, templateKey)
Java
BoxFolder folder = new BoxFolder(api, "id");
folder.deleteMetadata("myMetadataTemplate");
Python
client.folder(folder_id='11111').metadata(scope='enterprise', template='myMetadata').delete()
.NET
await client.MetadataManager.DeleteFolderMetadataAsync("11111", "enterprise", "marketingCollateral");
Node
client.folders.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
	.then(() => {
		// removal succeeded — no value returned
	});

This API returns a 204 No Content API response with no response body when the instance has been successfully removed from the folder.