Registra um check-in
POST/api/goals/key-results/{keyResultId}/check-ins
- Auth
- Exige token
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
O responsável do KR, o dono do objetivo, os líderes dele (diretos e indiretos; num objetivo de grupo, o líder do grupo) ou owner/admin; os outros: 403 `checkInDenied`. Ciclo fechado: 409 `cycleClosed`. `value` (o valor atual) ou, num entregável, `done`; `health` é o farol; `note` opcional. O progresso do KR e do objetivo é recalculado.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
keyResultIdobrigatório | path | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo da requisição application/json
| Nome | Tipo | Descrição |
|---|---|---|
valueopcional | number | |
doneopcional | boolean | |
healthobrigatório | ON_TRACK | AT_RISK | OFF_TRACK | |
noteopcional | string | max 2000 |
Respostas
| Código | Descrição |
|---|---|
201 | O objetivo, com os KRs. |
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. |
409 | Conflito com o estado atual do recurso. |
422 | `valueRequired`, `doneRequired`, `healthInvalid`. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/goals/key-results/<keyResultId>/check-ins" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"health":"ON_TRACK"}'