Update Database Taxonomy Term

Update a single term in a taxonomy by id.

A taxonomy is a hierarchical set of terms (categories, tags) you can attach to records.

This endpoint updates the database taxonomy term — only the fields you send are changed.

Update a single term in a taxonomy by id

put

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

VersionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Idstring · nullableRequired

Term id to update, from get_database_taxonomy_term_tree.

TaxonomyIdstring · nullableRequired

Taxonomy id that owns the term, from get_database_taxonomies.

Body

Update a single term in a taxonomy by id

correlationIdstringOptional

CorrelationId for each request

cultureCodestringOptional

Specify culture code when your response from the API should be localised. E.g.: en

timeZoneIdstringOptional

TimeZone

versionstringRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

envstringOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

projectIdstringRequired

ID of your project. Can be passed in a header as norbix-project-id.

databaseIntegrationIdstring · nullableOptional

Optional database integration id. When omitted, the project's default database integration is used.

updatestring · nullableRequired

Partial update document as MongoDB extended-JSON (a raw JSON object of fields to change), applied with $set — only the given fields change. Updatable term fields: name (string or {lang:value} map); description; order (integer sort position, lower shows first — use this to numerate/rank terms; set null to clear); parentId (single parent term id — a term from THIS taxonomy's parent taxonomy; e.g. link a country to its region by setting the country term's parentId to the region term id); multiParents ("additional categories": array of {taxonomyId, parentId}). Example to rank a term: {"order":1}.

Responses

200

Success

application/json

EmptyResponse

put/{version}/database/taxonomies/{TaxonomyId}/terms/{Id}

PUT /{version}/database/taxonomies/{TaxonomyId}/terms/{Id} HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 161

{
  "correlationId": "text",
  "cultureCode": "text",
  "timeZoneId": "text",
  "env": "text",
  "projectId": "text",
  "databaseIntegrationId": "text",
  "update": "text",
  "version": "text"
}

200

Success

{
  "success": {
    "responseStatus": {
      "isSuccess": true
    }
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Update Database Taxonomy Term in the SDK reference, with examples in every language.