Update leaderboards
Update leaderboards by ID. Updating status behaves the same as activating, scheduling, deactivating, or finishing a leaderboard in the dashboard.
Authorizations
Headers
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
Array of leaderboards to update. Each item must include an ID.
1 - 100 elementsThe UUID of the leaderboard to update.
"550e8400-e29b-41d4-a716-446655440100"
The updated leaderboard name.
The updated leaderboard key. This can only be changed while the leaderboard is inactive.
^[a-zA-Z\d-_]+$The updated leaderboard description.
The target user-facing status. scheduled activates a leaderboard whose start date is in the future. finished behaves like the dashboard finish action.
inactive, active, scheduled, finished The updated ranking criterion. This can only be changed while the leaderboard is inactive.
metric, streak, points The metric ID to use when rankBy is metric.
The points system ID to use when rankBy is points.
The updated maximum number of participants.
1 <= x <= 1000The updated start date in YYYY-MM-DD format.
The updated end date in YYYY-MM-DD format, or null to clear it.
The updated start of the daily ranking time window in HH:mm format, or null to clear it.
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"09:00"
The updated end of the daily ranking time window in HH:mm format, or null to clear it.
^([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9])?$"17:00"
The updated breakdown attribute UUIDs.
The updated recurrence unit.
day, month, year The updated recurrence interval.
x >= 1