Edita um badge
PATCH/api/badges/{id}
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- Clé d’API:
- gamification:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
namefacultatif | string | max 60 |
descriptionfacultatif | string | max 300 |
imageUrlfacultatif | string | |
visibilityfacultatif | public | private | |
rulefacultatif | 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. |
Réponses
| Statut | 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. |
Exemple 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 '{}'