Saltar al contenido

Apaga um resultado-chave

DELETE/api/goals/key-results/{keyResultId}

Auth
Requiere token
Clave de API:
No acepta clave de API
X-CommunityId
X-CommunityId Enví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.

Quem administra o objetivo, com o ciclo aberto. O último KR de um objetivo não sai (422 `keyResultsRequired`).

Parámetros

NombreDóndeTipoDescripción
keyResultIdobligatoriopathstring (uuid)

Headers

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

Respuestas

CódigoDescripción
200O objetivo, com os KRs.
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.
422`keyResultsRequired`.
500Erro interno do servidor.

Ejemplo con curl

curl -X DELETE "https://api.memberfy.net/api/goals/key-results/<keyResultId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"