Concede um badge à pessoa
POST/api/members/{memberId}/badges
- Auth
- Requiere token
- Quién puede:
- owner
- admin
- Clave de API:
- members: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. `reason` opcional (até 300). **201** quando concede agora; **200** com `changed: false` quando a pessoa já tem o badge (nada muda, nenhum aviso). Quem recebe é avisado no sino e por e-mail (categoria "Conquistas", com descadastro). É a ação "Conceder badge" (`badge.award`) do nó "Ação da plataforma".
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
memberIdobligatorio | 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 |
|---|---|---|
badgeIdobligatorio | string (uuid) | |
reasonopcional | string | max 300 |
Respuestas
| Código | Descripción |
|---|---|
200 | A pessoa já tinha o badge. |
201 | Concedido. |
400 | Requisição inválida — falha de validação. |
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. |
Ejemplo con curl
curl -X POST "https://api.memberfy.net/api/members/<memberId>/badges" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"badgeId":"00000000-0000-0000-0000-000000000000"}'