Skip to content

Team.update

Update team fields (name, etc.).

Signature

update(**kwargs: Any) -> None

Parameters

Name Type Required Default
**kwargs Any no -

HTTP parameters

Name In Type Required Default
team_id path string yes -

Fields

Schema: TeamUpdateSchema

Field Type Required
description string no
is_active boolean no
is_archived boolean no
name string yes
slug string no

Return shape

HTTP 200 — OK

Schema: TeamSchema

Field Type Required
description string no
id string yes
is_active boolean no
is_archived boolean no
member_count integer no
name string yes
pending_invitations_count integer no
slug string yes
tenant string yes

Permission

Required permission: team:update

HTTP

PATCH /api/teams/{id} (updateTeam)

Usage

team.update()