Patch
/api/teams/{team_id}
チームを更新します。
チーム更新にはそのチームの管理者権限が必要です。
チームには、最低でも1人のチーム管理者（team_admin）が所属している必要があります。
Security
API Key: ApiKeyAuth
Header parameter nameAuthorization
認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
API KEYがabc123の場合は、Authorization: Token abc123とします。
API KEYの作成方法は、TROCCO API KEYの作成を参照ください。
Path parameters
team_id
integer (int64) Required
チームID
Body parameters
object
name
string Required
チーム名
Exampleサンプルチーム
description
string
チームの説明
Exampleこれはサンプルチームの説明です。
members
Array of object Required
所属ユーザー。
membersの値によって、所属するユーザーは洗い替えされます。
既存ユーザーをチームから削除したくない場合は、既存ユーザーのidをmembersに含めてください。
Min items1
object
user_id
integer (int64)
ユーザーID メール認証済みのユーザーのみ指定可能です。
Example1
role
string
チーム権限
Valid values[
"team_admin",
"team_member"
]
Exampleteam_admin
Responses
200
更新したチームの詳細を返します。
object
id
integer (int64)
チームID
Example1
name
string
チーム名
Exampleサンプルチーム
description
string | null
チームの説明
Exampleこれはサンプルチームの説明です。
members
Array of object
所属ユーザー
Min items1
object
user_id
integer (int64)
ユーザーID
Example1
email
string
メールアドレス
Exampletrocco@example.com
role
string
チーム権限
Valid values[
"team_admin",
"team_member"
]
Exampleteam_admin
created_at
string
チームの作成日時
Example2023-08-23T03:00:00.000+09:00
updated_at
string
チームの更新日時
Example2023-08-23T03:00:00.000+09:00
400
チーム管理者が0人でリクエストしているなど、不正なリクエストです。
401
チーム更新権限がないか、API KEYが不正です。
404
指定したチームが存在しません。