Skip to main content
PATCH
JavaScript

Authorizations

X-API-KEY
string
header
required

Headers

Tenant-ID
string

The tenant identifier for multi-tenant organisations. Required when the organisation has multi-tenancy enabled. Pass your own internal customer ID for the tenant. Ignored for single-tenant organisations.

Body

application/json

Array of leaderboards to update. Each item must include an ID.

Required array length: 1 - 100 elements
id
string<uuid>
required

The UUID of the leaderboard to update.

Example:

"550e8400-e29b-41d4-a716-446655440100"

name
string

The updated leaderboard name.

key
string

The updated leaderboard key. This can only be changed while the leaderboard is inactive.

Pattern: ^[a-zA-Z\d-_]+$
description
string

The updated leaderboard description.

status
enum<string>

The target user-facing status. scheduled activates a leaderboard whose start date is in the future. finished behaves like the dashboard finish action.

Available options:
inactive,
active,
scheduled,
finished
rankBy
enum<string>

The updated ranking criterion. This can only be changed while the leaderboard is inactive.

Available options:
metric,
streak,
points
metricId
string<uuid>

The metric ID to use when rankBy is metric.

pointsSystemId
string<uuid>

The points system ID to use when rankBy is points.

maxParticipants
integer | null

The updated maximum number of participants.

Required range: 1 <= x <= 1000
start
string<date>

The updated start date in YYYY-MM-DD format.

end
string<date> | null

The updated end date in YYYY-MM-DD format, or null to clear it.

startTime
string | null

The updated start of the daily ranking time window in HH:mm format, or null to clear it.

Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$
Example:

"09:00"

endTime
string | null

The updated end of the daily ranking time window in HH:mm format, or null to clear it.

Pattern: ^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$
Example:

"17:00"

breakdownAttributes
string<uuid>[]

The updated breakdown attribute UUIDs.

runUnit
enum<string> | null

The updated recurrence unit.

Available options:
day,
month,
year
runInterval
integer

The updated recurrence interval.

Required range: x >= 1

Response

Successful operation

Response containing updated leaderboards and any per-item issues identified by leaderboard ID.

updated
AdminLeaderboard · object[]
required

Array of successfully updated leaderboards.

issues
AdminIssue · object[]
required

Array of issues encountered during leaderboard update.