Aller au contenu

Cria um ciclo

POST/api/goals/cycles

Auth
Jeton requis
Clé d’API:
Clé d’API non acceptée
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

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`.

En-têtes

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

Corps de la requête application/json

NomTypeDescription
spaceIdfacultatifstring (uuid)
titleobligatoirestringmax 120
startsOnobligatoirestring (date)
endsOnobligatoirestring (date)
reminderFrequencyfacultatifWEEKLY | BIWEEKLY | OFF
reminderWeekdayfacultatifinteger≥ 1, ≤ 7
reminderHourfacultatifinteger≥ 0, ≤ 23

Réponses

StatutDescription
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.

Exemple 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"}'