Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Latest version

Remove metadata template

delete
https://api.box.com/2.0
/metadata_templates/:scope/:template_key/schema

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Delete a metadata template and its instances. This deletion is permanent and can not be reversed.

Related Guides

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
global

The scope of the metadata template.

Value is one of global,enterprise

stringin pathrequired
properties

The name of the metadata template.

Response

none

Returns an empty response when the metadata template is successfully deleted.

application/jsonClient error

Request body does not contain a valid metadata schema.

application/jsonClient error

Request body contains a scope that the user is not allowed to create a template for.

application/jsonClient error

An unexpected client error.

delete
Remove metadata template
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X DELETE "https://api.box.com/2.0/metadata_templates/enterprise/blueprintTemplate/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.metadataTemplates.deleteMetadataTemplate(
  'enterprise' as DeleteMetadataTemplateScope,
  template.templateKey!,
);
Python v10
client.metadata_templates.delete_metadata_template(
    DeleteMetadataTemplateScope.ENTERPRISE, template.template_key
)
.NET v10
await client.MetadataTemplates.DeleteMetadataTemplateAsync(scope: DeleteMetadataTemplateScope.Enterprise, templateKey: NullableUtils.Unwrap(template.TemplateKey));
Swift v10
try await client.metadataTemplates.deleteMetadataTemplate(scope: DeleteMetadataTemplateScope.enterprise, templateKey: template.templateKey!)
Java v10
client.getMetadataTemplates().deleteMetadataTemplate(DeleteMetadataTemplateScope.ENTERPRISE, template.getTemplateKey())
Java v5
MetadataTemplate.deleteMetadataTemplate(api, "enterprise", "templateName");
Python v4
client.metadata_template('enterprise', 'employeeRecord').delete()
Node v4
client.metadata.deleteTemplate('enterprise', 'testtemplate', callback);