A valid request URL is required to generate request examples{
"level": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"rank": 123,
"requirements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "points",
"threshold": 123,
"metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"achievement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": "<string>",
"unit": "<string>"
}
],
"icon": "<string>",
"contacts": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Update a level
Requires engagement:manage. Renames a rung, moves it in the ladder, changes its glyph, or REPLACES what it asks for.
Editing the conditions is allowed, which is where a level differs from a rule and from a badge: those two describe HISTORY — “you earned this for X” — and this one describes now. The honest consequence is that people move immediately and silently, with no ledger line and nothing announced; the platform congratulates on the way up only, and the record of having reached a rung is kept so that meeting it again does not throw the same party twice.
A valid request URL is required to generate request examples{
"level": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"rank": 123,
"requirements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "points",
"threshold": 123,
"metric_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"achievement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"target": "<string>",
"unit": "<string>"
}
],
"icon": "<string>",
"contacts": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Authorizations
A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange. Only a 401 means it is spent; not_a_member (403) is about the organization named in X-Organization-Id and leaves the token good for the others.
Headers
The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing: the answer is not_a_member (403), which does not mean the session is over. Absent, the session's default organization answers, or — if that membership was revoked while the session was open — any other one the caller still holds.
Path Parameters
The level's id.
Body
601 <= x <= 1000What this rung asks for. ALL of them must hold. Send the whole set: on an update it REPLACES what is there, [] leaves the rung asking for nothing (and reachable by nobody), and omitting the field leaves the conditions alone. Never two about the same thing — two point thresholds on one rung is two answers rather than a stricter rung.
8Show child attributes
Show child attributes
16Response
The level.
A rung on the ladder, and everything it asks for. A level is a FUNCTION of what somebody holds and is stored on nobody: it is derived on every read as the highest rank whose every requirement is satisfied, which is what keeps it from disagreeing with the ledger, the tallies and the badges it describes.
Show child attributes
Show child attributes