Pular para o conteúdo

Edita um ciclo aberto

PUT/api/development-plans/cycles/{cycleId}

Auth
Exige token
Chave de API:
Não aceita chave de API
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Owner e admin, com o ciclo aberto (fechado, 409 `cycleClosed`). Todos os campos opcionais, mesmas regras de abrir.

Parâmetros

NomeOndeTipoDescrição
cycleIdobrigatóriopathstring (uuid)

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (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

NomeTipoDescrição
nameopcionalstringmax 120
submitByopcionalstring (date)
approveByopcionalstring (date)
audienceopcionalALL | GROUP | TAG
groupIdopcionalstring (uuid)
tagopcionalstringmax 80
reminderDaysopcionalinteger[]

Respostas

CódigoDescrição
200O ciclo.
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`).
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.
422Mesmas regras de abrir.

Exemplo com curl

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