---
title: "PATCH /v1/workspace/teams/{id}"
method: PATCH
path: "/v1/workspace/teams/{id}"
tags: ["workspace"]
---

# PATCH /v1/workspace/teams/{id}

`PATCH /v1/workspace/teams/{id}`

## Request

- Base URL: `https://help.steep.app` (the document declares no server; this is the origin it was published from)
- URL: `https://help.steep.app/v1/workspace/teams/{id}`
- Auth: none declared

Update a team by `id`. Omitted fields stay as they are.

## Path parameters

- `id` string, required: Unique resource ID (opaque).

## Request body

- object
  - `name` string
  - `description` unknown
  - `color` union
    - 'none' | 'gray' | 'gray-weak' | 'blue' | 'turquoise' | 'green' | 'yellow' | 'orange' | 'red' | 'pink' | 'purple'
    - string
  - `isPrivate` boolean: When true, only members of the team can see it.
  - `directoryGroupId` string: Links this team to a directory group. Can only be set on a currently unlinked team. Only for workspaces on the Enterprise plan with Directory sync enabled.

## Response `200`

Response for status 200

- object
  - `id` string, required: Unique resource ID (opaque).
  - `name` string, required
  - `description` unknown, required
  - `color` union, required
    - 'none' | 'gray' | 'gray-weak' | 'blue' | 'turquoise' | 'green' | 'yellow' | 'orange' | 'red' | 'pink' | 'purple'
    - string
  - `isPrivate` boolean, required: When true, only members of the team can see it.
  - `createdAt` string, required
  - `updatedAt` string, required
  - `directoryLinked` boolean, required: Whether membership is managed in the directory. Only for workspaces on the Enterprise plan with Directory sync enabled.
  - `directoryGroupId` unknown
  - `directoryGroupName` unknown

## Other responses

- `401`: Response for status 401
- `403`: Response for status 403
- `422`: Response for status 422
- `429`: Response for status 429
- `500`: Response for status 500

---

[API](https://skmtc.dev/steep/apis/steep-api.md) - [All operations](https://skmtc.dev/steep/apis/steep-api/llms.txt) - [OpenAPI document](https://skmtc.dev/steep/apis/steep-api/revisions/cc9677742952?raw)