Edita um ciclo aberto (título, período, lembrete)
PATCH/api/goals/cycles/{cycleId}
- Auth
- Exige token
- Chave de API:
- Não aceita chave de API
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Owner e admin; fechado: 409 `cycleClosed`.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
cycleIdobrigatório | path | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (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
| Nome | Tipo | Descrição |
|---|---|---|
titleopcional | string | max 120 |
startsOnopcional | string (date) | |
endsOnopcional | string (date) | |
reminderFrequencyopcional | WEEKLY | BIWEEKLY | OFF | |
reminderWeekdayopcional | integer | ≥ 1, ≤ 7 |
reminderHouropcional | integer | ≥ 0, ≤ 23 |
Respostas
| Código | Descrição |
|---|---|
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. |
Exemplo com 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 '{}'