Update metadata taxonomies

Update metadata taxonomy elements such as displayNames, descriptions, and other attributes of an existing taxonomy structure.

Update a metadata taxonomy

Use this endpoint to update top-level attributes of an existing taxonomy, such as changing its displayName. Call the API endpoint.

curl --request PATCH \ 
--url "https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}" \ 
--header "Authorization: Bearer YOUR_ACCESS_TOKEN" \ 
--header "Content-Type: application/json" \ 
--data '{ 
"displayName": "UPDATED DISPLAY NAME" 
}'

client.metadata_taxonomies.update_metadata_taxonomy(
    namespace, taxonomy_key, updated_display_name
)

await client.metadataTaxonomies.updateMetadataTaxonomy(namespace, taxonomyKey, {
  displayName: updatedDisplayName,
} satisfies UpdateMetadataTaxonomyRequestBody);

try await client.metadataTaxonomies.updateMetadataTaxonomy(namespace: namespace, taxonomyKey: taxonomyKey, requestBody: UpdateMetadataTaxonomyRequestBody(displayName: updatedDisplayName))

client.getMetadataTaxonomies().updateMetadataTaxonomy(namespace, taxonomyKey, new UpdateMetadataTaxonomyRequestBody(updatedDisplayName))

await client.MetadataTaxonomies.UpdateMetadataTaxonomyAsync(namespaceParam: namespaceParam, taxonomyKey: taxonomyKey, requestBody: new UpdateMetadataTaxonomyRequestBody(displayName: updatedDisplayName));

Additional information is available for the and of a taxonomy.

Update a taxonomy level

Update the display name and description of an existing level within a taxonomy. The level index identifies which level to update. Call the API endpoint with the displayName and description.

curl --request PATCH \ 
--url "https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}/levels/1" \ 
--header "Authorization: Bearer YOUR_ACCESS_TOKEN" \ 
--header "Content-Type: application/json" \ 
--data '{ 
"displayName": "Continent UPDATED", 
"description": "Continent Level UPDATED" 
}'

client.metadata_taxonomies.update_metadata_taxonomy_level_by_id(
    namespace,
    taxonomy_key,
    1,
    "Continent UPDATED",
    description="Continent Level UPDATED",
)

await client.metadataTaxonomies.updateMetadataTaxonomyLevelById(
  namespace,
  taxonomyKey,
  1,
  {
    displayName: 'Continent UPDATED',
    description: 'Continent Level UPDATED',
  } satisfies UpdateMetadataTaxonomyLevelByIdRequestBody,
);

try await client.metadataTaxonomies.updateMetadataTaxonomyLevelById(namespace: namespace, taxonomyKey: taxonomyKey, levelIndex: Int64(1), requestBody: UpdateMetadataTaxonomyLevelByIdRequestBody(displayName: "Continent UPDATED", description: "Continent Level UPDATED"))

client.getMetadataTaxonomies().updateMetadataTaxonomyLevelById(namespace, taxonomyKey, 1L, new UpdateMetadataTaxonomyLevelByIdRequestBody.Builder("Continent UPDATED").description("Continent Level UPDATED").build())

await client.MetadataTaxonomies.UpdateMetadataTaxonomyLevelByIdAsync(namespaceParam: namespaceParam, taxonomyKey: taxonomyKey, levelIndex: 1L, requestBody: new UpdateMetadataTaxonomyLevelByIdRequestBody(displayName: "Continent UPDATED") { Description = "Continent Level UPDATED" });

Additional information is available for the , , and of a taxonomy.

Update a taxonomy node

Use this endpoint to modify the display name or relationship attributes of an existing node in a taxonomy - for example, renaming Paris to Paris City. Call the API endpoint with the taxonomy’s displayName.

curl --request PATCH \ 
--url "https://api.box.com/2.0/metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}" \ 
--header "Authorization: Bearer YOUR_ACCESS_TOKEN" \ 
--header "Content-Type: application/json" \ 
--data '{ 
"displayName": "Poland UPDATED" 
}'

client.metadata_taxonomies.update_metadata_taxonomy_node(
    namespace, taxonomy_key, country_node.id, display_name="Poland UPDATED"
)

await client.metadataTaxonomies.updateMetadataTaxonomyNode(
  namespace,
  taxonomyKey,
  countryNode.id,
  {
    requestBody: {
      displayName: 'Poland UPDATED',
    } satisfies UpdateMetadataTaxonomyNodeRequestBody,
  } satisfies UpdateMetadataTaxonomyNodeOptionalsInput,
);

try await client.metadataTaxonomies.updateMetadataTaxonomyNode(namespace: namespace, taxonomyKey: taxonomyKey, nodeId: countryNode.id, requestBody: UpdateMetadataTaxonomyNodeRequestBody(displayName: "Poland UPDATED"))

client.getMetadataTaxonomies().updateMetadataTaxonomyNode(namespace, taxonomyKey, countryNode.getId(), new UpdateMetadataTaxonomyNodeRequestBody.Builder().displayName("Poland UPDATED").build())

await client.MetadataTaxonomies.UpdateMetadataTaxonomyNodeAsync(namespaceParam: namespaceParam, taxonomyKey: taxonomyKey, nodeId: countryNode.Id, requestBody: new UpdateMetadataTaxonomyNodeRequestBody() { DisplayName = "Poland UPDATED" });

Additional information is available for the , , and of a taxonomy.

Getting started

Applications & integrations

Identity & access

Using the API

Troubleshooting

Content

Collaboration

Metadata & search

Events & webhooks

Users

Intelligent workflow

E-signatures

Security & compliance

Update metadata taxonomies

Update a metadata taxonomy

Update a taxonomy level

Update a taxonomy node

​Update a metadata taxonomy

​Update a taxonomy level

​Update a taxonomy node

Update a metadata taxonomy

Update a taxonomy level

Update a taxonomy node