Remove metadata instance from file

delete

https://api.box.com/2.0

/files/:file_id/metadata/:scope/:template_key

Deletes a piece of file metadata.

Related Guides

MetadataRemove metadata from an item

Request

Content-Typeapplication/json

Path Parameters

file_id stringin pathrequired

example12345

The unique identifier that represent a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

scope stringin pathrequired

exampleglobal

The scope of the metadata template

Value is one of global,enterprise

template_key stringin pathrequired

exampleproperties

The name of the metadata template

Response

204none

Returns an empty response when the metadata is successfully deleted.

400application/jsonClient error

Returned when the request parameters are not valid. This may happen of the scope is not valid.

404application/jsonClient error

Returns an error when the file does not have an instance of the metadata template applied to it, or when the user does not have access to the file.

instance_not_found - An instance of the metadata template with the given scope and templateKey was not found on this file.
not_found - The file was not found, or the user does not have access to the file.

405application/jsonClient error

Returned when the method was not allowed.

defaultapplication/jsonClient error

An unexpected client error.

delete

Remove metadata instance from file

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -X DELETE https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

.NET

await client.MetadataManager.DeleteFileMetadataAsync("11111", "enterprise", "marketingCollateral");

Java

BoxFile file = new BoxFile(api, "id");
file.deleteMetadata("myMetadataTemplate");

Python

client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').delete()

Node

client.files.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
	.then(() => {
		// removal succeeded — no value returned
	});;

iOS

client.metadata.delete(
    forFileWithId: "11111",
    scope: "enterprise",
    templateKey: "personnelRecord"
) { (result: Result<Void, BoxSDKError>) in
    guard case .success = result {
        print("Error deleting metadata instance")
        return
    }

    print("Metadata instance deleted")
}