Create team

Creates a new team belonging to the authenticated org.

Required permission

Organisation > Team > General > Create

Request body

{object}

name
string required
The name of the team.
min length
3
max length
45
pattern
^[a-zA-Z](('[a-zA-Z])?(-|\s)?[a-zA-Z0-9]+(('[a-zA-Z])?(-|\s)[a-zA-Z0-9]+)*)?$
description
string
A description of the team.
max length
200
pattern
^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$
email
string required
The billing email address for the team.
pattern
^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$

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

POST /v1/teams

Example request

Request body

curl --header "Content-Type: application/json" \
  --header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
  --request POST \
  --data '{"name":"My Team","description":"This is my team.","email":"billing@example.com"}' \
  https://api.northflank.com/v1/teams

Example response

200 OK

Details about the newly created 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"
  }
}