Edita um badge
PATCH/api/badges/{id}
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- API key:
- gamification:write
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
Só owner e admin. Só os campos enviados mudam, com as regras de `POST /api/badges`. Quem já tem o badge passa a ver a versão nova na hora (a concessão aponta para o badge). Trocar para `private` tira o badge da vista de quem não é o próprio, owner ou admin.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
nameoptional | string | max 60 |
descriptionoptional | string | max 300 |
imageUrloptional | string | |
visibilityoptional | public | private | |
ruleoptional | object | F-189: um objeto grava a regra e recomeça a contagem agora (não retroativa); `null` tira; ausente mantém. Mesmos erros da criação. |
Responses
| Status | Description |
|---|---|
200 | Editado. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Nome já usado por outro badge da comunidade. |
422 | Campo inválido. |
curl example
curl -X PATCH "https://api.memberfy.net/api/badges/<id>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'