Skip to content

Fecha o ciclo

POST/api/development-plans/cycles/{cycleId}/close

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.

Owner e admin. Encerra os lembretes; os PDIs continuam, ligados ao ciclo. Já fechado, 409 `cycleClosed`.

Parameters

NameInTypeDescription
cycleIdrequiredpathstring (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

The specification does not declare the fields of this body (a multipart upload, for example). See the topic guide.

Responses

StatusDescription
200O ciclo, fechado.
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`).
403Sem permissão para esta ação no PDI (ex.: líder indireto ou financeiro tentando aprovar, `developmentPlan.errors.approveDenied`), espaço fechado para quem cria o próprio PDI, ou sessão de suporte do SuperAdmin (`supportSession`).
404Recurso não encontrado.
409Conflito com o estado atual do recurso.

curl example

curl -X POST "https://api.memberfy.net/api/development-plans/cycles/<cycleId>/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'