Liga ou desliga um tipo de reconhecimento
PUT/api/recognitions/types/{type}
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- 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.
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`).
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
typeobligatorio | path | APPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARY |
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 |
|---|---|---|
enabledobligatorio | boolean |
Respuestas
| Código | Descripción |
|---|---|
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. |
Ejemplo 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}'