Edita um ciclo aberto (título, período, lembrete)
PATCH/api/goals/cycles/{cycleId}
- Auth
- Richiede un token
- Chiave API:
- Non accetta chiavi API
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Owner e admin; fechado: 409 `cycleClosed`.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
cycleIdobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
titlefacoltativo | string | max 120 |
startsOnfacoltativo | string (date) | |
endsOnfacoltativo | string (date) | |
reminderFrequencyfacoltativo | WEEKLY | BIWEEKLY | OFF | |
reminderWeekdayfacoltativo | integer | ≥ 1, ≤ 7 |
reminderHourfacoltativo | integer | ≥ 0, ≤ 23 |
Risposte
| Codice | Descrizione |
|---|---|
200 | O ciclo. |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
409 | Conflito com o estado atual do recurso. |
422 | Campo inválido. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X PATCH "https://api.memberfy.net/api/goals/cycles/<cycleId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'