Skip to main content
PATCH
/
metadata_taxonomies
/
{namespace}
/
{taxonomy_key}
cURL
curl --request PATCH \
  --url https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayName": "Geography"
}
'
{
  "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
  "displayName": "Geography",
  "namespace": "enterprise_123456",
  "key": "geography",
  "levels": [
    {
      "displayName": "Continent",
      "description": "Continent",
      "level": 1
    }
  ]
}
This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.Learn more about Box SDK versioning strategy.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
namespace
string
required

The namespace of the metadata taxonomy.

​
taxonomy_key
string
required

The key of the metadata taxonomy.

Body

application/json
​
displayName
string
required

The display name of the taxonomy.

Maximum string length: 4096
Example:

"Geography"

Response

The schema representing the updated metadata taxonomy.

A taxonomy object for metadata that can be used in metadata templates.

​
id
string
required

A unique identifier of the metadata taxonomy.

Example:

"822227e0-47a5-921b-88a8-494760b2e6d2"

​
displayName
string
required

The display name of the metadata taxonomy. This can be seen in the Box web app.

Maximum string length: 4096
Example:

"Geography"

​
namespace
string
required

A namespace that the metadata taxonomy is associated with.

Maximum string length: 4096
Example:

"enterprise_123456"

​
key
string

A unique identifier of the metadata taxonomy. The identifier must be unique within the namespace to which it belongs.

Maximum string length: 256
Example:

"geography"

​
levels
Metadata taxonomy level · object[]

Levels of the metadata taxonomy.