Latest version
Remove metadata template
Delete a metadata template and its instances. This deletion is permanent and can not be reversed.
Request
bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
globalThe scope of the metadata template
Value is one of global,enterprise
stringin pathrequired
propertiesThe 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.
Request Example
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, 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")
}