Skip to content
Documentation

Create team

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

Creates a new team.

Authorizations

Section titled “Authorizations”

Request Body

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

Responses

Section titled “Responses”

201

Section titled “201”

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"
}

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."
    ]
  }
}