Updates the team with the specified id.

PUT

Updates the team with the specified id. Only updates properties which are not null or whitespace.

Required Permissions: The user must be an admin.

Path parameters

teamIdstringRequired
The id of the team.

Query parameters

includeUserIdsbooleanOptional
Whether the user ids should be included.
includeProjectIdsbooleanOptional
Whether the project ids should be included.

Request

This endpoint expects an object.
namestringRequired
The team name.
iconstringOptional

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’.

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

Response

This endpoint returns an object.
namestring
The team name.
iconstringOptional

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’.

colorstringOptional
The color of the team. Optional. Possible values: 'red', 'coral', 'yellow', 'green', 'teal', 'arctic', 'blue', 'azure', 'purple', 'violet'.
idstringOptional
The id of the team.
createdOndatetimeOptional
The date this team was created.
createdBystringOptional
The id of the user who created this team.
updatedOndatetimeOptional
The date this team was last modified.
updatedBystringOptional
The id of the user who last updated this team.
userIdslist of stringsOptional
The ids of the users in the team.
projectIdslist of stringsOptional
The ids of the projects in the team.