Skip to content

Create Team Leaderboard

POST
/sales-coach/team/leaderboards

Create a leaderboard.

id is caller-chosen, matching the app: these are config rows keyed by a slug you pick, and POSTing an id that already exists UPSERTS rather than failing. Said plainly because a caller retrying a create would otherwise assume a duplicate was rejected.

Requires team-floor management: org Owner/Admin, or an explicit sales_manager assignment.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

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.

object
goal
Any of:

The target a leaderboard is measured against.

object
metric
required
string
period
required
string
target
required
number
id
required

Caller-chosen id. Reusing one upserts, matching the app.

string
is_system

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.

boolean
kpis
required
Array<object>

One metric on a leaderboard, with its weight and visibility.

object
id
required

KPI id from GET /sales-coach/team/kpi-catalog.

string
visible
boolean
default: true
weight
required

How much this KPI counts toward the ranking.

number
name
required
string
roles
required

Which team roles appear on this board.

Array<string>

Responses

201

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string