Docs

Update team

PATCH
/teams/{team_id}

Update team. Only active teams can be updated.

Authorization

headerAuthorizationBearer <token>

Scope: team.write

Path Parameters

team_id*string

The unique identifier of the team.

Match^[a-zA-Z0-9_-]+$

Request Body

Update team request.

application/json
  1. body
name?string

The name of the team. Must be unique within the project.

Length1 <= length <= 200

Response Body

Updated the team.

application/json
  1. response

Details of a team.

id*string

The unique identifier of the team.

name*string

The name of the team.

status*team-status

The lifecycle state of a team.

active: The team is available for use. deactivated: The team is no longer active but is retained for historical and audit purposes.

Value in"active""deactivated"
created_at*string

The time when the team was created.

Formatdate-time
updated_at*string

The time when the team was last updated.

Formatdate-time
Example Request
import { configureZitadel, getApi } from "@zitadel/api/config";import { setApiCsrfToken } from "@zitadel/api/runtime/auth";// In the browser, through the SDK proxy: the session cookie authenticates the call.const client = getApi(configureZitadel({ projectId: "proj_01KWH1P4MYS7F0N9WD3P2E4YM5" }));// A write the session cookie authenticates carries the session's CSRF token.setApiCsrfToken((await client.getMySessionCsrfToken()).csrf_token);const team = await client.updateTeam("team_01KZZY8PX8K8ATNVDSMRCZY4N1", {});
Example Response
{  "id": "string",  "name": "string",  "status": "active",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Was this helpful?