teams
Update team
Updates the fields and/or members of an existing team. Supports both field updates via fields and member management via patch operations. Both can be combined in a single request.
Updatable Fields
- name: The name of the team (1-255 characters)
- handle: Unique handle for @mentions (lowercase alphanumeric only)
- description: Optional description of the team (max 10,000 characters)
Patch Operations on Members
Use patch array to manage team members with these operations:
- addItems: Add members to the team (idempotent, skips already-present members)
- removeItems: Remove members from the team (idempotent, skips already-absent members)
- set: Replace entire member list atomically
- clear: Remove all members from the team
Maximum 100 member references per operation.
Response
Returns a reference to the updated team. Use the GET endpoint to retrieve the full updated team details.
patch/teams/{id}
Path parameters
idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000
Team identifier.
Request body
Example request
{
"data": {
"fields": {
"name": "Product Team",
"handle": "productteam",
"description": "Team responsible for product development"
}
}
}Response
Team updated successfully
Example response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "team",
"links": {
"self": "https://api.productboard.com/v2/teams/123e4567-e89b-12d3-a456-426614174000",
"members": "https://api.productboard.com/v2/teams/123e4567-e89b-12d3-a456-426614174000/members",
"html": "https://example.productboard.com/settings/teams/12"
}
}
}