Skip to main content
POST
Add a step to a badge checklist

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.

Body

application/json

The new BadgeStep resource

One step of a badge's checklist, as the organisation defines it.

Steps are ordered by position within a badge. A step that members have already recorded progress against is archived rather than deleted (BadgeStepRemoveController), so a member's history keeps reading correctly; archived steps are excluded from every progress count.

Mirrors BadgeType: integer id, no uuid, tenant column of its own (which is what ItemGetSecurityUserTenantExtension and CollectionSecurityCurrentUserExtension key tenant isolation off).

badge
string<iri-reference>
Example:

"/api/v1/badges/1"

position
integer
default:1
title
string
description
string | null
translation
string | null
isOptional
boolean
default:false

Response

BadgeStep resource created

One step of a badge's checklist, as the organisation defines it.

Steps are ordered by position within a badge. A step that members have already recorded progress against is archived rather than deleted (BadgeStepRemoveController), so a member's history keeps reading correctly; archived steps are excluded from every progress count.

Mirrors BadgeType: integer id, no uuid, tenant column of its own (which is what ItemGetSecurityUserTenantExtension and CollectionSecurityCurrentUserExtension key tenant isolation off).

id
integer
read-only
badge
string<iri-reference>
Example:

"/api/v1/badges/1"

position
integer
default:1
title
string
description
string | null
translation
string | null
isOptional
boolean
default:false
isArchived
boolean
default:false
dateCreated
string<date-time>
read-only
dateUpdated
string<date-time> | null
read-only