---
title: "Update Team"
method: PUT
path: "/teams/{team_id}"
tags: ["Teams"]
---

# Update Team

`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

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.

## Path parameters

- `team_id` string, required: Team id (UUID).

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- TeamUpdateRequest: Update a team. Mirrors `teams.TeamUpdateDTO`. An omitted `*_ids` list LEAVES that attachment alone; a list that is present REPLACES it (the handler diffs). Sending `[]` therefore detaches everything of that kind, which is not the same instruction as omitting it.
  - `name` string, nullable
  - `type` string, nullable
  - `description` string, nullable
  - `color` string, nullable: Hex colour, e.g. #FF5733. An empty string clears it.
  - `agent_id` string, nullable: Single workspace AI agent; empty string clears it.
  - `chat_intent` string, nullable: 'support' | 'sales' | null. An empty string clears it.
  - `members` WorkspaceMemberInput[], nullable
    - `user_id` string, required
    - `role` 'member' | 'manager': member | manager
  - `mailbox_ids` integer[], nullable
  - `phone_number_ids` integer[], nullable
  - `linkedin_account_ids` string[], nullable
  - `campaign_ids` string[], nullable
  - `sequence_ids` string[], nullable
  - `chatbot_ids` string[], nullable

## Response `200`

Successful Response

- ApiResponseOrgPayload
  - `data` OrgPayload, 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".
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)