Hanzo AIDocs
Sign inAPI key

Replace rooms

States what a room is for: its lifecycle intent, and what it is about.

PUT /v1/team/rooms/{id}

Team → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/team/rooms/{id}
MethodPUT
Operationput_team_rooms_by_id
AuthAuthorization: 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 space rather than on the next reload. A team member binds a room they can see; an application of the org binds its public channels only; anybody else without a team session is 401.

Request

5 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the room to bind, from the path.
bindingsbodystring[]—Bindings REPLACES what the room is about, wholly.
idbodystring—ID is the room to bind, from the path.
lifebodystring—Life sets the lifecycle intent: "standing" or "bound".
spacebodystring—Space names the space holding the room.

Response

StatusBodyMeaning
200team.teamRoomok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
archivedbodyboolean—Archived reports that the room has been closed.
bindingsbodystring[]—Bindings are what this room is ABOUT, each a "<kind>:<ref>" string — "project:acme/web", "repo:hanzoai/cloud", "issue:1010".
directbodyboolean—Direct reports that this is a room between people rather than a named room.
idbodystring—ID is the room document's own id, and the value the bind op addresses.
kindbodystring—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).
lifebodystring—Life is the room's lifecycle INTENT — "standing" or "bound" (HIP-0523 §2).
membersbodystring[]—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.
namebodystring—Name is what a person sees in a sidebar.
privatebodyboolean—Private reports that the room is restricted to its members.
spacebodystring—Space is the space uuid holding this room.
topicbodystring—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 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 := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TeamAPI.PutTeamRoomsById(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::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.setBearerToken(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 33 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": "list_team_account_providers"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

Was this page useful?
PreviousReplace reactionsNextDelete calls