Edita um badge
PATCH/api/badges/{id}
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- gamification:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
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.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
namefacoltativo | string | max 60 |
descriptionfacoltativo | string | max 300 |
imageUrlfacoltativo | string | |
visibilityfacoltativo | public | private | |
rulefacoltativo | object | Um objeto grava a regra e recomeça a contagem agora (não retroativa); `null` tira; ausente mantém. Mesmos erros da criação. |
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio con curl
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 '{}'