Liga ou desliga um tipo de reconhecimento
PUT/api/recognitions/types/{type}
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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`).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
typerequired | path | APPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARY |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
enabledrequired | boolean |
Responses
| Status | Description |
|---|---|
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. |
curl example
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}'