# Update channels

URL: https://docs.hanzo.ai/docs/openapi/team/patch-team-channels-by-id

> Renames a channel, sets its topic, or archives or reopens it, and answers the channel as it now stands.

`PATCH /v1/team/channels/{id}`

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

|               |                                              |
| ------------- | -------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/team/channels/{id}` |
| **Method**    | `PATCH`                                      |
| **Operation** | `patch_team_channels_by_id`                  |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`       |

Renames a channel, sets its topic, or archives or reopens it, and
answers the channel as it now stands.

Its owners and the space's admins may edit a channel; a channel nobody owns — one
opened by an integration — may be edited by anyone in it, and a direct
message by either person in it. Archiving withdraws a public channel from the
cross-org directory in the same write; reopening lists it again.

## Request

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

| Field      | In   | Type    | Required | Description                                               |
| ---------- | ---- | ------- | -------- | --------------------------------------------------------- |
| `id`       | path | string  | yes      | ID is the channel, from the path.                         |
| `archived` | body | boolean | —        | Archived closes the channel (true) or reopens it (false). |
| `id`       | body | string  | —        | ID is the channel, from the path.                         |
| `name`     | body | string  | —        | Name renames a channel.                                   |
| `space`    | body | string  | —        | Space is the space uuid holding it.                       |
| `topic`    | body | string  | —        | Topic sets the channel's one-line subject; "" clears it.  |

## Response

| Status    | Body                | Meaning |
| --------- | ------------------- | ------- |
| `200`     | team.teamChannelOne | ok      |
| `default` | problem-details     | refused |

`200` body — 12 fields.

| Field              | In   | Type             | Always | Description                                                                                                                                                                                                                       |
| ------------------ | ---- | ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `channel`          | body | team.teamChannel | —      |                                                                                                                                                                                                                                   |
| `channel.archived` | body | boolean          | —      | Archived reports that the channel has been closed.                                                                                                                                                                                |
| `channel.bindings` | body | string\[]        | —      | Bindings are what this channel is ABOUT, each a "\<kind>:\<ref>" string — "project:acme/web", "repo:hanzoai/cloud", "issue:1010".                                                                                                 |
| `channel.direct`   | body | boolean          | —      | Direct reports that this is a channel between people rather than a named channel.                                                                                                                                                 |
| `channel.id`       | body | string           | —      | ID is the channel document's own id, and the value the bind op addresses.                                                                                                                                                         |
| `channel.kind`     | body | string           | —      | Kind is what sort of channel this is: "public" (open to everyone in the space), "private" (open to its members) or "dm" (a conversation between the people in it).                                                                |
| `channel.life`     | body | string           | —      | Life is the channel's lifecycle INTENT — "standing" or "bound" (HIP-0523 §2).                                                                                                                                                     |
| `channel.members`  | body | string\[]        | —      | Members are the account uuids in the channel, agents included: an agent projects as a space member under a uuid derived from its id, so a caller comparing this against GET /v1/bot/members learns which channels an agent is in. |
| `channel.name`     | body | string           | —      | Name is what a person sees in a sidebar.                                                                                                                                                                                          |
| `channel.private`  | body | boolean          | —      | Private reports that the channel is restricted to its members.                                                                                                                                                                    |
| `channel.space`    | body | string           | —      | Space is the space uuid holding this channel.                                                                                                                                                                                     |
| `channel.topic`    | body | string           | —      | Topic is the channel's own one-line subject, as the Team client sets it.                                                                                                                                                          |

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

## Examples

**CLI**

```bash
hanzo team channels update <id>
```

**SDK**

**.ts**

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

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.patchTeamChannelsById({ id: 'id', archived: false, id: "<id>" });
```

**.py**

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TeamApi(client).patch_team_channels_by_id(id='id', archived=False, id="<id>")
```

**.go**

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

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

**.rs**

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

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

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

**.java**

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

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

var result = new TeamApi(client).patchTeamChannelsById();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl -X PATCH https://api.hanzo.ai/v1/team/channels/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "archived": false,
       "id": "<id>"
     }'
```

**MCP**

MCP reaches **team** through the `team` tool, which names its 33 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_team_account_providers"
         }
       }
     }'
```

---

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