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"
}
}Create a level
Requires engagement:manage. A level is a name, a place in the ladder and a set of conditions; there is nothing to turn on, because a level is not something that fires — it is what somebody’s standing MEANS.
Everybody who already satisfies the requirements is in it immediately, and nobody is ANNOUNCED into it: points.level_reached fires on the next award, not on this call.
A rung with no requirements is reached by NOBODY rather than by everybody, which is the safe reading of a level somebody has not finished writing. Omit rank to put the rung above the last one.
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"
}
}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.
Query Parameters
Which environment to act in. A view parameter, valid only on the staff surface — a machine credential never chooses its environment, it is resolved from the key.
live, test Body
60Its place in the ladder, unique per environment. Omit for the top.
1 <= 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
An emoji or short glyph. null clears it.
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