Skip to main content
PATCH
Update a Badge

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Badge ID in this school.

Required string length: 1 - 255

Body

name
string

Unique badge name in your school. Required when creating and cannot be blank.

Required string length: 1 - 50
image_type
enum<string>
default:emoji

Badge display mode. upload and ai require a saved image. To generate an image, use Generate a Badge Image.

Available options:
emoji,
upload,
ai
emoji
string

Badge emoji, defaulting to 🏆. Cannot be null or blank in emoji mode.

Maximum string length: 10000

Response

Successful response.

id
string
required
name
string
required
image_type
enum<string>
required
Available options:
emoji,
upload,
ai
emoji
string | null
required
image_url
string | null
required

Saved badge image URL, including when emoji mode is selected.