Skip to content

Delete Team Leaderboard

DELETE
/sales-coach/team/leaderboards/{lb_id}

Delete a leaderboard.

The app answers 204 with no body. This returns {"deleted": true} in the standard envelope instead, because every other operation on this contract returns one and a client that special-cased an empty body here would be the only place it had to.

Authorizations

Parameters

Path Parameters

lb_id
required

Leaderboard id.

string

Leaderboard id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

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