Skip to main content
POST
Record one checklist step

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

BadgeUser identifier

Body

application/json
stepId
integer
required
status
enum<integer> | null
Available options:
0,
1,
null
note
string | null

Response

BadgeUser resource created

id
integer
read-only
badge
object
user
object
dateCreated
string<date-time>
commentUser
string | null
commentMaster
string | null
status
integer | null
owner
object
pointsAtAward
integer | null
badgeUserSteps
object[]
stepsProgress
(string | null)[]
read-only