Replace rooms

States what a room is for: its lifecycle intent, and what it is about. It answers the room as it now stands.

PUT /v1/team/rooms/{id}

Team → · All API references → · Get started →


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

States what a room is for: its lifecycle intent, and what it is about. It answers the room as it now stands.

The write is a platform MIXIN on the room document, applied through the SAME applyTx path the Team client's own writes take and broadcast to every connected client — so a room bound here updates live in an open workspace rather than on the next reload.

Request

5 fields, body application/json (required).

Field	In	Type	Required	Description
`id`	path	string	yes	ID is the room to bind, from the path.
`bindings`	body	string[]	—	Bindings REPLACES what the room is about, wholly.
`id`	body	string	—	ID is the room to bind, from the path.
`life`	body	string	—	Life sets the lifecycle intent: "standing" or "bound". Any other value is refused rather than stored, so a reader never has to interpret a third one.
`workspace`	body	string	—	Workspace names the workspace holding the room.

Response

Status	Body	Meaning
`200`	teamRoom	ok

200 body — 10 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.
`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 workspace member under a uuid derived from its id, so a caller comparing…
`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.
`topic`	body	string	—	Topic is the room's own one-line subject, as the Team client sets it.
`workspace`	body	string	—	Workspace is the workspace uuid holding this room.

Failure carries the platform error shape — see Errors.

Examples

hanzo team rooms set <id>

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putTeamRoomsById({ id: 'id', bindings: ["<bindings>"], 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).put_team_rooms_by_id(id='id', bindings=["<bindings>"], id="<id>")

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

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

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

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

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new TeamApi(client).putTeamRoomsById();

curl -X PUT https://api.hanzo.ai/v1/team/rooms/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "bindings": [
         "<bindings>"
       ],
       "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