Box Developer Documentation

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

Delete a metadata template

Delete a metadata template

Deleting a metadata template can be achieved by calling the DELETE /metadata_templates/enterprise/:templateKey/schema API.

cURL
curl -i -X DELETE "https://api.box.com/2.0/metadata_templates/enterprise/blueprintTemplate/schema" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.metadataTemplates.deleteMetadataTemplate(
  'enterprise' as DeleteMetadataTemplateScope,
  template.templateKey!,
);
Python Gen
client.metadata_templates.delete_metadata_template(
    DeleteMetadataTemplateScope.ENTERPRISE.value, template.template_key
)
.NET Gen
await client.MetadataTemplates.DeleteMetadataTemplateAsync(scope: DeleteMetadataTemplateScope.Enterprise, templateKey: NullableUtils.Unwrap(template.TemplateKey));
Swift Gen (Beta)
try await client.metadataTemplates.deleteMetadataTemplate(scope: DeleteMetadataTemplateScope.enterprise, templateKey: templateKey)
Java
MetadataTemplate.deleteMetadataTemplate(api, "enterprise", "templateName");
Python
client.metadata_template('enterprise', 'employeeRecord').delete()
Node
client.metadata.deleteTemplate('enterprise', 'testtemplate', callback);
iOS
client.metadata.deleteTemplate(
    scope: "enterprise",
    templateKey: "personnelRecord"
) { (result: Result<Void, BoxSDKError>) in
    guard case .success = result {
        print("Error deleting metadata template")
        return
    }

    print("Metadata template deleted")
}

This API returns a 204 No Content API response with no response body when the template has been successfully deleted. This API also removes all the template instances from any files and folders.

Only templates created within the enterprise scope can be deleted.

Admin permissions required

Deleting metadata templates is restricted to users with admin permission. This means that only admins, or co-admins who have been granted rights to Create and edit metadata templates for your company by the admin can use the web app or the API to manage templates.