API v1 ReferenceTeams

Updates the team with the specified id.

Updates the team with the specified id. Only updates properties which are not null or whitespace. <Check title="Required Permissions">The user must be an admin.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

teamIdstringRequiredformat: "uuid"
The id of the team.

Query Parameters

includeUserIdsbooleanOptionalDefaults to false
Whether the user ids should be included.
includeProjectIdsbooleanOptionalDefaults to false
Whether the project ids should be included.

Request

The new team values.
namestringRequired0-255 characters
The team name.
iconstring or nullOptional0-25 characters
The icon of the team. Optional. Possible values: 'attach_money', 'poll', 'golf_course', 'all_inclusive', 'portrait', 'timeline', 'transform', 'description', 'folder', 'computer', 'web', 'phone_iphone', 'cloud', 'local_movies', 'shopping_cart', 'brush', 'image', 'camera_alt', 'movie_creation', 'public', 'whatshot', 'extension', 'explore', 'lock', 'settings', 'stars', 'store', 'school', 'local_bar', 'question_answer', 'favorite', 'work', 'flight_takeoff', 'map', 'local_dining'.
colorstring or nullOptional0-14 characters

The color of the team. Optional. Possible values: ‘red’, ‘coral’, ‘yellow’, ‘green’, ‘teal’, ‘arctic’, ‘blue’, ‘azure’, ‘purple’, ‘violet’.

Response

OK
namestring0-255 characters
The team name.
iconstring or null0-25 characters
The icon of the team. Optional. Possible values: 'attach_money', 'poll', 'golf_course', 'all_inclusive', 'portrait', 'timeline', 'transform', 'description', 'folder', 'computer', 'web', 'phone_iphone', 'cloud', 'local_movies', 'shopping_cart', 'brush', 'image', 'camera_alt', 'movie_creation', 'public', 'whatshot', 'extension', 'explore', 'lock', 'settings', 'stars', 'store', 'school', 'local_bar', 'question_answer', 'favorite', 'work', 'flight_takeoff', 'map', 'local_dining'.
colorstring or null0-14 characters

The color of the team. Optional. Possible values: ‘red’, ‘coral’, ‘yellow’, ‘green’, ‘teal’, ‘arctic’, ‘blue’, ‘azure’, ‘purple’, ‘violet’.

idstring or nullformat: "uuid"
The id of the team.
createdOnstring or nullformat: "date-time"
The date this team was created.
createdBystring or nullformat: "uuid"
The id of the user who created this team.
updatedOnstring or nullformat: "date-time"
The date this team was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last updated this team.
userIdslist of strings or null
The ids of the users in the team.
projectIdslist of strings or null
The ids of the projects in the team.