Update rooms

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

PATCH /v1/team/rooms/{id}

Team → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/team/rooms/{id}`
Method	`PATCH`
Operation	`patch_team_rooms_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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

Its owners and the space's admins may edit a room; a room 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 room, from the path.
`archived`	body	boolean	—	Archived closes the room (true) or reopens it (false).
`id`	body	string	—	ID is the room, 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.teamRoom	ok
`default`	problem-details	refused

200 body — 11 fields.

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

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, TeamApi } from 'hanzoai';

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

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_rooms_by_id(id='id', archived=False, id="<id>")

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

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

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_rooms_by_id(&cfg, Default::default()).await?;

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).patchTeamRoomsById();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (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 →

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

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

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": "get_collaborator"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page