# Replace categories

URL: https://docs.hanzo.ai/docs/openapi/taxonomy/put-taxonomy-categories-by-id

> Creates or replaces one category and returns it as stored.

`PUT /v1/taxonomy/categories/{id}`

> [Taxonomy →](https://docs.hanzo.ai/docs/openapi/taxonomy) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                    |
| ------------- | -------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/taxonomy/categories/{id}` |
| **Method**    | `PUT`                                              |
| **Operation** | `put_taxonomy_categories_by_id`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`             |

Creates or replaces one category and returns it as stored. The id in
the URL is the one it is filed under whatever the body says, so a category can
never be written under a name it was not addressed by — which also makes create
and replace the same act, and is why there is no POST beside this.

Platform SuperAdmin only: one catalogue serves every tenant, so an org admin who
could rename a category would rename it for all of them.

## Request

6 fields, body `application/json` (required).

| Field     | In   | Type            | Required | Description                                                     |
| --------- | ---- | --------------- | -------- | --------------------------------------------------------------- |
| `id`      | path | string          | yes      | ID is the category slug to write, from the path.                |
| `brands`  | body | string\[]       | —        | Brands are the brands whose console shows it.                   |
| `id`      | body | string          | —        | ID is the category slug to write, from the path.                |
| `label`   | body | string          | —        | Label is the display name.                                      |
| `order`   | body | integer (int64) | —        | Order is where the category sits among its siblings, ascending. |
| `summary` | body | string          | —        | Summary is the one line describing what the category groups.    |

## Response

| Status    | Body              | Meaning |
| --------- | ----------------- | ------- |
| `200`     | taxonomy.Category | ok      |
| `default` | problem-details   | refused |

`200` body — 19 fields.

| Field                | In   | Type              | Always | Description                                                                                                                        |
| -------------------- | ---- | ----------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `brands`             | body | string\[]         | —      | Brands are the brands whose console shows this category.                                                                           |
| `id`                 | body | string            | —      | ID is the stable slug this category is addressed by, e.g. "observe".                                                               |
| `label`              | body | string            | —      | Label is the display name, e.g. "Observe".                                                                                         |
| `order`              | body | integer (int64)   | —      | Order is where the category sits among its siblings, ascending.                                                                    |
| `owner`              | body | string            | —      | Owner is the org this category belongs to: the platform's own org for a category every tenant sees, or your org for one you added. |
| `summary`            | body | string            | —      | Summary is the one line describing what the category groups, shown as the header copy on its landing page.                         |
| `taxa`               | body | taxonomy.Taxon\[] | —      | Taxa are the products filed under this category, in display order.                                                                 |
| `taxa[].brands`      | body | string\[]         | —      | Brands are the brands whose console shows this taxon.                                                                              |
| `taxa[].category`    | body | string            | —      | Category is the id of the category this taxon is filed under.                                                                      |
| `taxa[].description` | body | string            | —      | Description is the one line shown beneath the name in the catalogue and nav.                                                       |
| `taxa[].href`        | body | string            | —      | Href is the absolute URL an external product launches, for the taxa that genuinely live at their own domain.                       |
| `taxa[].icon`        | body | string            | —      | Icon names the icon the surface renders, e.g. "Database".                                                                          |
| `taxa[].id`          | body | string            | —      | ID is the stable slug this taxon is addressed by, e.g. "vector".                                                                   |
| `taxa[].name`        | body | string            | —      | Name is the display name, e.g. "Vector".                                                                                           |
| `taxa[].order`       | body | integer (int64)   | —      | Order is where the taxon sits within its category, ascending.                                                                      |
| `taxa[].owner`       | body | string            | —      | Owner is the org this product belongs to: the platform's own org for one every tenant sees, or your org for one you added.         |
| `taxa[].published`   | body | boolean           | —      | Published is whether the taxon is shown.                                                                                           |
| `taxa[].route`       | body | string            | —      | Route is the in-console path this taxon opens, e.g. "/vector".                                                                     |
| `taxa[].tags`        | body | string\[]         | —      | Tags are free-form labels for search and grouping across categories.                                                               |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo taxonomy categories set <id>
```

**SDK**

**.ts**

```ts
import { Configuration, TaxonomyApi } from 'hanzoai';

const api = new TaxonomyApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putTaxonomyCategoriesById({ id: 'id', brands: ["<brands>"], id: "<id>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TaxonomyApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TaxonomyApi(client).put_taxonomy_categories_by_id(id='id', brands=["<brands>"], id="<id>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TaxonomyAPI.PutTaxonomyCategoriesById(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, taxonomy_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = taxonomy_api::put_taxonomy_categories_by_id(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TaxonomyApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new TaxonomyApi(client).putTaxonomyCategoriesById();
```

**HTTP**

```bash
curl -X PUT https://api.hanzo.ai/v1/taxonomy/categories/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "brands": [
         "<brands>"
       ],
       "id": "<id>"
     }'
```

**MCP**

MCP reaches **taxonomy** through the `taxonomy` tool, which names its 5 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_taxonomies"
         }
       }
     }'
```

---

[Taxonomy API](https://docs.hanzo.ai/docs/openapi/taxonomy) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
