Edita um badge
PATCH/api/badges/{id}
- Auth
- Requiere token
- Quién puede:
- owner
- admin
- Clave de API:
- gamification:write
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
nameopcional | string | max 60 |
descriptionopcional | string | max 300 |
imageUrlopcional | string | |
visibilityopcional | public | private | |
ruleopcional | 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. |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo 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 '{}'