LogoLogo
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
SupportDeveloper ForumLogin
API v1 ReferenceTeams

Updates the team with the specified id.

PUT
https://api.awork.com/api/v1/teams/:teamId
PUT
/api/v1/teams/:teamId
1curl -X PUT https://api.awork.com/api/v1/teams/teamId \
2     -H "Authorization: Bearer <token>" \
3     -H "Content-Type: application/json" \
4     -d '{
5  "name": "Designers",
6  "icon": "image",
7  "color": "purple"
8}'
Try it
200Updated
1{
2  "name": "Designers",
3  "icon": "image",
4  "color": "purple",
5  "id": "123e4567-e89b-12d3-a456-426614174000",
6  "createdOn": "createdOn",
7  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
8  "updatedOn": "updatedOn",
9  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
10  "userIds": [
11    "userIds"
12  ],
13  "projectIds": [
14    "projectIds"
15  ]
16}
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>

Path parameters

teamIdUUIDRequired
The id of the team.

Headers

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

Query parameters

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

Request

This endpoint expects an object.
namestringRequired>=0 characters<=255 characters
The team name.
iconstring or nullOptional>=0 characters<=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 nullOptional>=0 characters<=14 characters
The color of the team. Optional. Possible values: 'red', 'coral', 'yellow', 'green', 'teal', 'arctic', 'blue', 'azure', 'purple', 'violet'.

Response

OK
namestring>=0 characters<=255 characters
The team name.
iconstring or null>=0 characters<=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 null>=0 characters<=14 characters
The color of the team. Optional. Possible values: 'red', 'coral', 'yellow', 'green', 'teal', 'arctic', 'blue', 'azure', 'purple', 'violet'.
idUUID or null
The id of the team.
createdOndatetime or null
The date this team was created.
createdByUUID or null
The id of the user who created this team.
updatedOndatetime or null
The date this team was last modified.
updatedByUUID or null
The id of the user who last updated this team.
userIdslist of UUIDs or null
The ids of the users in the team.
projectIdslist of UUIDs or null
The ids of the projects in the team.
Was this page helpful?
Previous

Deletes the team with the specified id.

Next
Built with
The id of the team.
Whether the user ids should be included.
Whether the project ids should be included.
OK

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

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

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

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

Required Permissions
The user must be an admin.

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

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