Skip to content
AiKYNETIX

Create a client group

POST
/api/client-groups/
curl --request POST \
  --url http://localhost:8000/api/client-groups/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Sprint squad", "description": "100–400 m specialists", "colour": "tone-recovery" }'

Create a team-scoped group. name is required and must be unique within the team (a duplicate returns 400). Membership is managed separately via the /members/ endpoints.

403 when the caller has no active team selected (a transient state, e.g. mid team-switch).

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

A team-scoped client group (#545). name / description / colour are writable on create + PATCH; the roster (member_ids) is read-only here — mutate it via the /members/ endpoints. member_count powers the board column header without a second round-trip.

object
name
required

Group name. Required; unique within the team.

string
>= 1 characters <= 120 characters
description

Optional free-text description of the group.

string
<= 500 characters
colour

Optional UI tint — a design-token key (e.g. tone-recovery) or empty. Cosmetic; the board falls back to a deterministic colour.

string
<= 32 characters
Examples
ExampleCreateAGroup

Create a group

{
  "name": "Sprint squad",
  "description": "100–400 m specialists",
  "colour": "tone-recovery"
}

Responses

Section titled “Responses”

201

Section titled “201”
Media typeapplication/json

A team-scoped client group (#545). name / description / colour are writable on create + PATCH; the roster (member_ids) is read-only here — mutate it via the /members/ endpoints. member_count powers the board column header without a second round-trip.

object
id
required
string format: uuid
name
required

Group name. Required; unique within the team.

string
<= 120 characters
description

Optional free-text description of the group.

string
<= 500 characters
colour

Optional UI tint — a design-token key (e.g. tone-recovery) or empty. Cosmetic; the board falls back to a deterministic colour.

string
<= 32 characters
member_ids
required

UUIDs of the clients in this group (many-to-many).

Array<string>
member_count
required

Number of clients in the group.

integer
created_at
required
string format: date-time
updated_at
required
string format: date-time
Examples
ExampleSprintSquad

Sprint squad

{
  "id": "b3f1c0a2-0000-4000-8000-000000000001",
  "name": "Sprint squad",
  "description": "100–400 m specialists",
  "colour": "tone-recovery",
  "member_ids": [
    "a1f1c0a2-0000-4000-8000-0000000000aa"
  ],
  "member_count": 1,
  "created_at": "2026-06-10T12:00:00Z",
  "updated_at": "2026-06-10T12:00:00Z"
}

400

Section titled “400”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string
Examplegenerated
{
  "detail": "example"
}

401

Section titled “401”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string
Examplegenerated
{
  "detail": "example"
}

403

Section titled “403”
Media typeapplication/json
object
detail
required

Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).

string
Examplegenerated
{
  "detail": "example"
}