Skip to content
memberfy
US

Reconhece uma ou mais pessoas

POST/api/recognitions

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send 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.

Qualquer papel que abra o espaço (`spaceId`; opcional enquanto a comunidade tem um só espaço de Reconhecimento, obrigatório com vários: 422 `spaceRequired`). Mensagem de até 500 caracteres; de 1 a 20 pessoas, todas perfis vivos da mesma comunidade que abrem o espaço; ninguém reconhece a si mesmo (422 com `errors`). `valueId` é opcional e só aceita valor ativo. O reconhecimento entra no feed da seção; quem tem pontos nas regras do Engajamento (`GIVE_RECOGNITION`, `RECEIVE_RECOGNITION`, padrão 0) ganha, com teto: `GIVE_RECOGNITION` conta no máximo 3 por autor por dia, e `RECEIVE_RECOGNITION` uma vez por par autor→pessoa em 7 dias (hoje e os 6 anteriores), no fuso da comunidade. Além do teto o reconhecimento é criado igual, só sem esses pontos. Cada pessoa reconhecida recebe, 10 minutos depois e pela fila, o e-mail "você foi reconhecido" (categoria `recognition`, que ela pode desligar; até 3 avisos por dia). `data.emailNotice` traz `{ scheduled, recipientCount }`.

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
spaceIdoptionalstring (uuid)Espaço de Reconhecimento onde o reconhecimento entra.
recipientIdsrequiredstring (uuid)[]
messagerequiredstringmax 500
valueIdoptionalstring (uuid)
typeoptionalAPPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARYO tipo (padrão `APPRECIATION`). Tipo inexistente ou desligado na comunidade: 400 (`typeInvalid`, `typeDisabled`).

Responses

StatusDescription
201O reconhecimento criado (`RecognitionCard` + `emailNotice`).
400Requisição inválida — falha de validação.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
422Sem mensagem ou acima de 500, sem pessoas ou mais de 20, a si mesmo, pessoa de outra comunidade ou que não abre o espaço, valor inativo/inexistente, ou sem `spaceId` numa comunidade com vários espaços de Reconhecimento (`spaceRequired`).
500Erro interno do servidor.

curl example

curl -X POST "https://api.memberfy.net/api/recognitions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"recipientIds":["00000000-0000-0000-0000-000000000000"],"message":"string"}'