Liga ou desliga um tipo de reconhecimento
PUT/api/recognitions/types/{type}
- Auth
- Richiede un token
- Chiave API:
- Non accetta chiavi API
- 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.
Owner e admin (moderador, financeiro e membro: 403). Vale para todos os espaços de Reconhecimento da comunidade. Desligado, o tipo some do "Reconhecer" (criar com ele dá 400), mas os reconhecimentos já feitos continuam aparecendo com a arte do tipo. Pelo menos um tipo fica ligado: desligar o último dá 400 (`lastTypeEnabled`) e nada muda. Tipo inexistente: 400 (`typeInvalid`).
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
typeobbligatorio | path | APPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARY |
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 |
|---|---|---|
enabledobbligatorio | boolean |
Risposte
| Codice | Descrizione |
|---|---|
200 | O tipo (`RecognitionTypeInfo`). |
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. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X PUT "https://api.memberfy.net/api/recognitions/types/<type>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"enabled":true}'