Teams

Update Team

Changed on Oct 13, 2026

Update name, icon, or badge color

patch/api/v3/meta/workspaces/{workspaceId}/teams/{teamId}

Request

Base URL
https://app.nocodb.com
Auth
- API key in header xc-token
- or HTTP bearer
TypeScript
https://skmtc.dev/nocodb/apis/nocodb-v3/docs/api/v3/meta/workspaces/:workspaceId/teams/:teamId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

workspaceIdstring required

Workspace ID

teamIdstring required

Team ID

Request body

titlestring

Updated team name

iconstring nullable

Updated team icon (emoji or icon identifier)

icon_type'EMOJI' | 'ICON' nullable

Team icon type

badge_colorstring

Updated team badge color (hex code)

Example request

{
  "title": "Updated Team Name",
  "icon": "🛠️",
  "icon_type": "EMOJI",
  "badge_color": "#00AEEF"
}

Response

Updated team

idstring required

Unique team identifier

titlestring required

Team name

iconstring nullable

Team icon (emoji or icon identifier)

icon_type'EMOJI' | 'ICON' nullable

Team icon type

badge_colorstring

Team badge color (hex code)

members_countinteger required

Number of team members

managers_countinteger

Number of team managers

fk_org_idstring

Organization ID (for Cloud Enterprise)

fk_workspace_idstring

Workspace ID (for other plans)

created_atstring date-time

Team creation timestamp

updated_atstring date-time

Team last update timestamp

fk_parent_team_idstring nullable

Parent team ID. Null = root team.

depthinteger

Depth in the team tree. Root teams have depth 0.

pathstring

Materialized path for efficient ancestor/descendant queries.

is_memberboolean

Whether the requesting user is a member of this team.

scim_managedboolean

Whether the team is provisioned by SCIM from an identity provider.

managersstring[]

List of user IDs who are owners/managers of this team.

Example response

{
  "id": "t12345",
  "title": "Design Team",
  "icon": "🎨",
  "icon_type": "EMOJI",
  "badge_color": "#FF5733",
  "members_count": 10,
  "managers_count": 2,
  "depth": 1,
  "path": "/eng/fe/web"
}

Changes

Oct 13, 20262ba4267a99d7 Revision changes
- warning
  deleted the query request parameter include_workspace
- info
  api operation id teams-update-v3 removed and replaced with teams-update
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status

Operation history