Update team

Updates the description of a team belonging to the authenticated org.

Required permission

Organisation > Team > General > Update

Path parameters

teamId
string required
ID of the team

Request body

{object}

description
string
A description of the team.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
ID of the team.
pattern
^[A-Za-z0-9-]+$
uid
string
Permanent identifier for the resource. Unlike `id`, it never changes and is never reused.
min length
24
max length
24
name
string required
Display name of the team.
description
string
Description of the team.
createdAt
string required
The time the team was created.
updatedAt
string
The time the team was last updated.

API

CLI

JS Client

PATCH /v1/teams/{teamId}

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request PATCH \
  --data '{"description":"This is my team."}' \
  https://api.northflank.com/v1/teams/{teamId}

Example response

200 OK

Details about the updated team.

JSON

{
  "data": {
    "id": "my-team",
    "uid": "68f0aa1b9c4e2d7f11a3b402",
    "name": "My Team",
    "description": "This is my team.",
    "createdAt": "2021-01-20T11:19:53.175Z",
    "updatedAt": "2021-01-20T11:19:53.175Z"
  }
}