Skip to content

Badges

Endpoints for badge management, including creating, updating, retrieving, and deleting badges. Badges are awarded to learners based on their performance or progress in the learning system.

Operations

Create badge

Request

Security
imfKey
Bodyapplication/json
namestring
iconstring
requirementsArray of objects
createdAtstring, (date-time)
updatedAtstring, (date-time)
curl -i -X POST \
  https://innovario.apishowdown.com/_mock/cicd-repo/openapi/badges \
  -H 'Content-Type: application/json' \
  -H 'IMF-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Explorer",
    "icon": "/images/explorer-icon.png",
    "requirements": [
      {
        "type": "quiz",
        "name": "Who we are",
        "minScore": 0.85,
        "maxAttempts": 1,
        "status": "done"
      }
    ],
    "createdAt": "2023-02-19T11:21:36Z",
    "updatedAt": "2023-02-19T11:21:36Z"
  }'

Responses

Created.

Bodyapplication/json
idstringread-only
namestring
iconstring
requirementsArray of objects
createdAtstring, (date-time)
updatedAtstring, (date-time)
Response
{
  "id": "badge_abc987def123",
  "name": "Explorer",
  "icon": "/images/explorer-icon.png",
  "requirements": [
    { … }
  ],
  "createdAt": "2023-02-19T11:21:36Z",
  "updatedAt": "2023-02-19T11:21:36Z"
}