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

Update a metadata taxonomy level

Updates an existing level in a metadata taxonomy. Identify the taxonomy with namespace and taxonomy_key, then specify the level position with level_index and provide the replacement displayName. You can also update the level's description; the response returns the updated level.

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

3 parameters · 2 body fields
namespacestringrequired
The namespace associated with the metadata taxonomy.
taxonomy_keystringrequired
The key of the metadata taxonomy containing the level.
level_indexintegerrequired
The integer index of the metadata taxonomy level to update.

The metadata taxonomy level properties to update. displayName is required.

displayNamestringrequired
The display name of the taxonomy level.
descriptionstringoptional
The description of the taxonomy level.

4 status codes
200Returns the updated metadata taxonomy level, including its display name, description, and level index.
displayNamestringoptional
The display name of the level as it is shown to the user.
descriptionstringoptional
A description of the level.
levelintegeroptional
An index of the level within the taxonomy. Levels are indexed starting from 1.
400Returned when the request parameters or body are invalid, including when `displayName` is missing.
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. A 403 is returned when the authenticated user cannot modify the taxonomy or access the specified namespace. level_index must identify the integer position of the taxonomy level being updated.