Skip to content

Update Team Set

PUT
/sales-coach/team/sets/{set_id}

Replace a rotation. A PUT: an omitted board leaves the rotation.

Authorizations

Parameters

Path Parameters

set_id
required

Set id.

string

Set id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A ROTATION of leaderboards - what a wall display cycles through.

object
audio_enabled

Whether the display plays a sound on a change.

boolean
id
required

Caller-chosen id.

string
is_default
boolean
leaderboard_ids
required

The boards to rotate through, in order.

Array<string>
name
required
string
rotation_seconds

Seconds per board. The app’s default is 30.

integer
default: 30

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