Skip to main content
PATCH
Update a badge

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

Badge identifier

Body

application/merge-patch+json

The updated Badge resource

name
string
type
object | null
translation
string | null
logo
string | null
referrals
integer | null
defaultNote
string | null
pointsRequired
integer | null
level
integer | null
tierBenefits
(string | null)[] | null
kind
string
default:badge
userType
string<iri-reference> | null
Example:

"/api/v1/roles/1"

autoCompleteOnSteps
boolean
default:true

Response

Badge resource updated

name
string
required
id
integer
read-only
type
object | null
translation
string | null
logo
string | null
referrals
integer | null
defaultNote
string | null
pointsRequired
integer | null
level
integer | null
tierBenefits
(string | null)[] | null
kind
string
default:badge
userType
object | null
autoCompleteOnSteps
boolean
default:true
steps
object[]
read-only