Sample - Box Platform API
PATCH/metadata_taxonomies/{namespace}/{taxonomy_key}

Update a metadata taxonomy

Updates the display name of an existing metadata taxonomy. Identify the taxonomy with namespace and taxonomy_key, then provide the new displayName value. The response contains the updated taxonomy schema and its configured levels.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 1 body field
namespacestringrequired
The namespace associated with the metadata taxonomy.
taxonomy_keystringrequired
The unique key of the metadata taxonomy within its namespace.

The metadata taxonomy properties to update. displayName is required.

displayNamestringrequired
The display name of the taxonomy.

4 status codes
200Returns the updated metadata taxonomy, including its identifier, key, display name, namespace, and hierarchical levels.
idstringrequired
A unique identifier of the metadata taxonomy.
keystringoptional
A unique identifier of the metadata taxonomy. The identifier must be unique within the namespace to which it belongs.
displayNamestringrequired
The display name of the metadata taxonomy. This can be seen in the Box web app.
namespacestringrequired
A namespace that the metadata taxonomy is associated with.
levelsarray<MetadataTaxonomyLevel>optional
Levels of the metadata taxonomy.
400Returned when the request parameters or body are invalid, including when `displayName` is missing or exceeds 4096 characters.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
403Returned when the authenticated user does not have permission to modify the metadata taxonomy or access the specified namespace.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 400 is returned when the request parameters or body are invalid, including when displayName is missing or exceeds 4096 characters. A 403 is returned when the authenticated user cannot modify the taxonomy or access the specified namespace. displayName must be a string of no more than 4096 characters.