Edita um resultado-chave
PATCH/api/goals/key-results/{keyResultId}
- 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.
Quem administra o objetivo, com o ciclo aberto. O valor atual só muda pelo check-in.
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 |
|---|---|---|
titleopcional | string | max 200 |
ownerIdopcional | string (uuid) | |
unitopcional | PERCENT | NUMBER | CURRENCY | |
directionopcional | INCREASE | DECREASE | MAINTAIN | DELIVERABLE | |
initialValueopcional | number | |
targetValueopcional | number | |
minValueopcional | number | |
maxValueopcional | number | |
weightopcional | number |
Respostas
| Código | Descrição |
|---|---|
200 | 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 | `targetInvalid`. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X PATCH "https://api.memberfy.net/api/goals/key-results/<keyResultId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'