Teams

Update Team

Update a team, and optionally re-attach everything on it in one call.

An omitted *_ids list LEAVES that attachment alone. A list that IS present REPLACES it, so sending [] detaches every mailbox (or number, or campaign) the team had. Omitting and sending an empty list are different instructions and the second one is destructive - the handler diffs.

put/teams/{team_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/teams/{team_id}
  • Auth: HTTP bearer

Path parameters

team_idstring required

Team id (UUID).

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

namestring nullable
typestring nullable
descriptionstring nullable
colorstring nullable

Hex colour, e.g. #FF5733. An empty string clears it.

agent_idstring nullable

Single workspace AI agent; empty string clears it.

chat_intentstring nullable

'support' | 'sales' | null. An empty string clears it.

mailbox_idsinteger[] nullable
phone_number_idsinteger[] nullable
linkedin_account_idsstring[] nullable
campaign_idsstring[] nullable
sequence_idsstring[] nullable
chatbot_idsstring[] nullable

Response

Successful Response

dataOrgPayload required

An open envelope for a single role, team, member or account record.

Open on purpose. The app's own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as "they do not have it".

Changes

No recorded changes to this operation across all 2 revisions of this API.