Skip to main content
POST
/
badges
Create badge definition
curl --request POST \
  --url https://api.hixbe.com/certify/badges \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Hixbe-Version: <hixbe-version>' \
  --data '
{
  "name": "Certified Expert",
  "image_url": "https://example.com/badges/expert-badge.png",
  "criteria": "Successfully complete advanced certification exam with 90% or higher score"
}
'
{
  "id": "badge_1234567890abcdef",
  "name": "Certified Expert"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Hixbe-Version
string
required

API version in YYYY-MM-DD format

Example:

"2026-01-01"

Body

application/json

Request payload for creating a new badge definition

​
name
string
required

Display name for the badge

Example:

"Certified Expert"

​
image_url
string<uri>
required

URL to the badge image

Example:

"https://example.com/badges/expert-badge.png"

​
criteria
string

Description of how to earn this badge

Example:

"Successfully complete advanced certification exam with 90% or higher score"

Response

Badge definition created successfully

Response containing badge definition information

​
id
string

Unique identifier for the badge definition

Example:

"badge_1234567890abcdef"

​
name
string

Display name of the badge

Example:

"Certified Expert"