Saltar para o conteúdo

Cria um ciclo

POST/api/goals/cycles

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 (os outros: 403 `teamOnly`). Nasce aberto, com o lembrete de check-in semanal (segunda, 9h no fuso da comunidade), que muda para quinzenal ou desliga. Num espaço "um ciclo" que já tem um: 409 `singleModeHasCycle`.

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
spaceIdopcionalstring (uuid)
titleobrigatóriostringmax 120
startsOnobrigatóriostring (date)
endsOnobrigatóriostring (date)
reminderFrequencyopcionalWEEKLY | BIWEEKLY | OFF
reminderWeekdayopcionalinteger≥ 1, ≤ 7
reminderHouropcionalinteger≥ 0, ≤ 23

Respostas

CódigoDescrição
201O 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`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Título vazio, dia inválido, fim antes do início (`periodInvalid`), lembrete inválido.
500Erro interno do servidor.

Exemplo com curl

curl -X POST "https://api.memberfy.net/api/goals/cycles" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","startsOn":"string","endsOn":"string"}'