Hanzo AIDocs
Sign inAPI key

Create members

Adds people to a room and answers the room as it now stands.

POST /v1/team/rooms/{id}/members

Team → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/team/rooms/{id}/members
MethodPOST
Operationpost_team_rooms_by_id_members
AuthAuthorization: Bearer $HANZO_API_KEY

Adds people to a room and answers the room as it now stands.

Anyone in the space except a guest may join a public channel by naming themselves. Adding somebody else takes being in the room already (or administering the space, for a room they can see). A direct message's people are what it is, so none can be added — open another one. Everyone added must be a member of the space or one of the org's agents; an agent added to a room answers when it is @-mentioned there.

Request

4 fields, body application/json (required).

FieldInTypeRequiredDescription
idpathstringyesID is the room, from the path.
idbodystring—ID is the room, from the path.
membersbodystring[]—Members are the account uuids to add — people or agents of the space.
spacebodystring—Space is the space uuid holding it.

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 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.postTeamRoomsByIdMembers({ id: 'id', id: "<id>", members: ["<members>"] });
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).post_team_rooms_by_id_members(id='id', id="<id>", members=["<members>"])
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TeamAPI.PostTeamRoomsByIdMembers(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::post_team_rooms_by_id_members(&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).postTeamRoomsByIdMembers();
curl -X POST https://api.hanzo.ai/v1/team/rooms/<id>/members \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "id": "<id>",
       "members": [
         "<members>"
       ]
     }'

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?
PreviousCreate repliesNextCreate messages