Skip to content
AiKYNETIX

Reorder which group's target ranges win

POST
/api/client-groups/ranges-priority/
curl --request POST \
  --url http://localhost:8000/api/client-groups/ranges-priority/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "group_ids": [ "b3f1c0a2-0000-4000-8000-000000000002", "b3f1c0a2-0000-4000-8000-000000000001" ] }'

A client in several groups that each carry their own range for the same metric is scored, per metric, against the group first in (ranges_priority, created_at, id) order (#2518). This sets that order: the listed group_ids take the top positions in the given order, the team’s remaining groups follow in their current order, and every group is renumbered 0..n-1 in one transaction. Returns the team’s groups in the new order.

400 when a listed id is not a group of the caller’s team (the whole request is refused; unknown and foreign ids read the same), when an id repeats, or when group_ids is empty. 403 for a partner API key (human team members only, like the threshold configurator) and when the caller has no active team selected.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”

Request body for POST /api/client-groups/ranges-priority/ (#2518): the groups whose ranges should win, highest precedence first. Groups left out keep their relative order below the listed ones.

object
group_ids
required

Client-group UUIDs, highest precedence first. Each must be a group of the caller’s team and appear once.

Array<string>

Examples

ExampleU14First,ThenTheSprintSquad

U14 first, then the sprint squad

{
  "group_ids": [
    "b3f1c0a2-0000-4000-8000-000000000002",
    "b3f1c0a2-0000-4000-8000-000000000001"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>

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
has_ranges
required

Whether the group carries any target range of its own (#2518) — a MetricThreshold row with client_group = this group. Edit them in /api/thresholds/?client_group=<id>.

boolean
ranges_priority
required

Precedence of this group’s own target ranges (#2518) for a client in several groups: per metric, the group first in (ranges_priority, created_at, id) order wins — LOWER wins. Not unique (ties fall back to creation order). Read-only here; set it with POST /api/client-groups/ranges-priority/. A new group starts at the bottom.

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

Examples

ExampleTheTeam'sGroupsInTheNewOrder

Each group in the new order — U14 first, `ranges_priority` 0

[
  {
    "id": "b3f1c0a2-0000-4000-8000-000000000002",
    "name": "U14",
    "description": "",
    "colour": "tone-recovery",
    "member_ids": [],
    "member_count": 0,
    "has_ranges": true,
    "ranges_priority": 0,
    "created_at": "2026-06-10T12:00:00Z",
    "updated_at": "2026-06-10T12:00:00Z"
  }
]

400

Section titled “400”

Unknown / other-team / repeated id, or an empty list (keyed on group_ids).

Media typeapplication/json

Validation error keyed by field — each value lists its messages.

object
key
additional properties
Array<string>

Examples

Example400—AGroupThatIsn'tThisTeam's

400 — a group that isn't this team's

{
  "group_ids": [
    "One or more groups are unknown for this team."
  ]
}

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

Example generated

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

Example generated

{
  "detail": "example"
}