Delete a user-rank
DELETE /user-ranks/{id}
DELETE
/user-ranks/{id}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
DocumentId
Responses
Section titled “ Responses ”Deleted
object
data
object
user
required
xp_total
required
integer
rank_level
required
string
badges
Array of { badge_code, awarded_at } — badge_code references badge-definition.code
automation_score
Latest automation-score snapshot; historical values live in gamification-event, not here
number
current_streak_days
required
integer
longest_streak_days
required
integer
last_activity_at
string format: date-time
leaderboard_opt_out
F4.GAM.06 — per-user opt-out of org leaderboard exposure. Even when an organisation’s leaderboard_enabled is true, a member with this set is excluded from GET /api/organisations/:id/leaderboard results. Self-service, but NOT writable via the generic service-only user-rank update route — the owning user sets it via the dedicated PUT /api/user-ranks/me/leaderboard-opt-out endpoint (the one exception to user-rank’s service-write-only rule, scoped to this single boolean field).
boolean
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
Missing or invalid authentication
Not authorized (tenant scope or capability)
Not found