---
title: "Update Team Leaderboard"
method: PUT
path: "/sales-coach/team/leaderboards/{lb_id}"
tags: ["Sales Coach"]
---

# Update Team Leaderboard

`PUT /sales-coach/team/leaderboards/{lb_id}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/sales-coach/team/leaderboards/{lb_id}`
- Auth: HTTP bearer

Replace a leaderboard's configuration.

A PUT, matching the app: the body is the board's new state, so a KPI you
omit is REMOVED from the board rather than left alone.

## Path parameters

- `lb_id` string, required: Leaderboard id.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- LeaderboardConfigRequest: A leaderboard: who is on it, what it measures, and what it is aiming at. `id` is REQUIRED and client-supplied, matching the app - these are config rows keyed by a slug the caller chooses, not server-generated records. Sending an existing id through `POST` is how the app upserts.
  - `id` string, required: Caller-chosen id. Reusing one upserts, matching the app.
  - `name` string, required
  - `roles` string[], required: Which team roles appear on this board.
  - `kpis` LeaderboardKpi[], required
    - `id` string, required: KPI id from `GET /sales-coach/team/kpi-catalog`.
    - `weight` number, required: How much this KPI counts toward the ranking.
    - `visible` boolean
  - `goal` LeaderboardGoal: The target a leaderboard is measured against.
    - `metric` string, required
    - `target` number, required
    - `period` string, required
  - `is_system` boolean: Marks a board the product ships rather than one a customer made. Accepted because the app's model has it; leave it False for your own boards.

## Response `200`

Successful Response

- ApiResponseTeamPayload
  - `data` TeamPayload, required: An open envelope for a config, a bootstrap or a data response. Open because the leaderboard and set DATA responses carry one key per KPI and the KPI catalogue is org-configurable: a closed model would drop a customer's own metric, and a leaderboard missing a column reads as a rep having scored nothing.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)