A valid request URL is required to generate request examples{
"achievement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"hidden": true,
"kind": "event_count",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"threshold": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"holders": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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 badge
Requires engagement:manage. Partial, and the condition is not editable — sending kind, rule_id, threshold, segment_id or key is a 400.
A badge already on somebody’s shelf says “you did this”. Editing what “this” means would change what every existing unlock claims, retroactively and with nothing on the screen saying so. What you can change is what it looks like and whether it is offered.
A valid request URL is required to generate request examples{
"achievement": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"environment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"key": "<string>",
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"hidden": true,
"kind": "event_count",
"rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"threshold": 123,
"segment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"active": true,
"holders": 123,
"created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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 badge's id.
Body
Response
The badge.
A badge. Unlike a segment, it does not stop being true: the unlock is written down and the condition is never asked again for that person.
Show child attributes
Show child attributes