Skip to content
Documentation

Update team

PATCH
/api/v1/teams/{id}
curl --request PATCH \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/teams/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "badge_color": "white" }'

Updates a single team by ID.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
integer

Team ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
string
badge_color
string
Allowed values: white black gray red green blue yellow purple pink orange brown cyan lime teal indigo

Responses

Section titled “Responses”

200

Section titled “200”

Successful

Media typeapplication/json
object
id
required
integer
name
required
string
badge_color
required
string
Allowed values: white black gray red green blue yellow purple pink orange brown cyan lime teal indigo
workspace_id
required
integer
created_at
required
string format: date-time
Example
{
  "id": 12345,
  "name": "Liverpool FC",
  "badge_color": "white",
  "workspace_id": 12345,
  "created_at": "2023-08-23T10:30:00.000Z"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}