Skip to main content
PUT
/
v1
/
teams
/
{id}
{
  "name": "Acme Corporation Inc",
  "username": "acme-corp",
  "about": "Leading provider of innovative solutions worldwide"
}

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Acme Corporation Inc",
    "username": "acme-corp",
    "about": "Leading provider of innovative solutions worldwide",
    "logo": "https://example.com/logos/acme.png"
  }
}
Update an existing team. You can only update teams where you are the owner.
If you update the username field, it must remain unique across both teams and users. Updating to an existing username will cause the request to fail.

​
Path Parameters

​
id
integer
required
The unique identifier of the team to update.

​
Request Body

​
name
string
required
The name of the team. Maximum 55 characters.
​
username
string
required
The unique username for the team. Must be unique across teams and users if changed. Maximum 255 characters. Must match pattern: ^[a-zA-Z0-9\-\_]+$.
​
about
string
Description or about text for the team. Maximum 5000 characters.
All request body fields are required for update. The avatar field cannot be updated through this endpoint.

​
Example Request

{
  "name": "Acme Corporation Inc",
  "username": "acme-corp",
  "about": "Leading provider of innovative solutions worldwide"
}

​
Example Response

{
  "success": true,
  "data": {
    "id": 1,
    "name": "Acme Corporation Inc",
    "username": "acme-corp",
    "about": "Leading provider of innovative solutions worldwide",
    "logo": "https://example.com/logos/acme.png"
  }
}

​
Error Response

{
  "success": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "You are not authorized to update this team."
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The given data was invalid.",
    "details": {
      "username": ["The username has already been taken."]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer<int64>
required

ID of team to update

Body

application/json

Team data to update

​
name
string
required

The name of the team

Maximum string length: 55
​
username
string
required

The unique username for the team (must be unique across teams and users)

Maximum string length: 255
​
about
string

Description or about text for the team

Maximum string length: 5000

Response

Team updated

​
success
boolean
required

Indicates whether the request was successful

Example:

true

​
data
object
required

The response data. Can be an object, array, or null