Sales Coach

Update Team Leaderboard

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.

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

Path parameters

lb_idstring required

Leaderboard id.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

idstring required

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

namestring required
rolesstring[] required

Which team roles appear on this board.

is_systemboolean

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

Successful Response

dataTeamPayload 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.

Changes

No recorded changes to this operation across all 2 revisions of this API.