Skip to content

Edita um objetivo

PATCH/api/goals/objectives/{objectiveId}

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.

Quem administra o objetivo (o dono, quem criou, os líderes do dono, o líder do grupo ou de um grupo acima, owner/admin; os outros: 403 `manageDenied`), com o ciclo aberto. Trocar o alinhamento avisa o dono do novo objetivo de cima.

Parameters

NameInTypeDescription
objectiveIdrequiredpathstring (uuid)

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
titleoptionalstringmax 200
descriptionoptionalstring
visibilityoptionalOPEN | RESTRICTED
ownerIdoptionalstring (uuid)
parentIdoptionalstring (uuid)

Responses

StatusDescription
200O objetivo, com os KRs.
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.
409Conflito com o estado atual do recurso.
422Campo inválido.
500Erro interno do servidor.

curl example

curl -X PATCH "https://api.memberfy.net/api/goals/objectives/<objectiveId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'