Sign in
Teams

Updates an existing team with a new name.

put/api/teams/{team_id}/

Path parameters

team_idstring required

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Request body

namestring required

A human friendly name for this team.

default_rolestring nullable

The uid of the role you want to assign to the team in the given workspace. You can omit this property if you want to remove the role.

Response

idinteger required
namestring required

A human friendly name for this team.

workspaceinteger required

The workspace that this team belongs to.

created_onstring date-time required
updated_onstring date-time required
default_rolestring

The uid of the role this team has in its workspace.

subject_countinteger required

The amount of subjects (e.g. users) that are currently assigned to this team.

Changes

No recorded changes to this endpoint across all 6 revisions of this API.