Update a badge-definition
PUT /badge-definitions/{id}
PUT
/badge-definitions/{id}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
DocumentId
Request Body required
Section titled “Request Body required ”object
data
object
code
required
Stable machine-readable identifier referenced by user-rank.badges[].badge_code and gamification-consumer trigger evaluation
string
title
required
string
description
string
icon
Icon name or emoji — no file upload, rendered client-side
string
xp_reward
required
integer
trigger_type
required
string
trigger_threshold
integer
active
required
boolean
Responses
Section titled “ Responses ”Updated
object
data
object
code
required
Stable machine-readable identifier referenced by user-rank.badges[].badge_code and gamification-consumer trigger evaluation
string
title
required
string
description
string
icon
Icon name or emoji — no file upload, rendered client-side
string
xp_reward
required
integer
trigger_type
required
string
trigger_threshold
integer
active
required
boolean
documentId
string
id
integer
createdAt
string format: date-time
updatedAt
string format: date-time
publishedAt
string format: date-time
Validation error
Missing or invalid authentication
Not authorized (tenant scope or capability)
Not found