Liga, desliga e ajusta um e-mail automático
PUT/api/campaigns/automatic/{systemKey}
- Auth
- Exige token
- Quem pode:
- owner
- admin
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
**Só owner e admin.** Todos os campos são opcionais. `enabled: true` **liga o envio em massa recorrente** e exige `consent: true` na primeira vez (a confirmação de que são membros da comunidade e aceitam comunicados; fica guardada); agenda o próximo disparo no dia e hora (fuso da comunidade). `enabled: false` impede o próximo envio. Também edita `subject`, `intro` (HTML sanitizado; apresenta o conteúdo, mas **sozinho não dispara nada**), `weekdays` (0 = domingo), `timeOfDay` e `blocks` (lista de `posts`, `courses`, `events`, `classifieds`). Semana sem nada novo: o disparo é pulado e registrado. Respeita descadastro e supressão, só traz conteúdo visível a todo o público e **conta na cota** de disparos; sem cota, o disparo é pulado e o owner recebe um aviso por e-mail (uma vez por disparo). `systemKey` desconhecida é 404.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
systemKeyobrigatório | path | WEEKLY_DIGEST |
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 |
|---|---|---|
enabledopcional | boolean | |
consentopcional | boolean | |
subjectopcional | string | max 300 |
introopcional | string | |
weekdaysopcional | integer[] | |
timeOfDayopcional | string | |
blocksopcional | posts | courses | events | classifieds[] |
Respostas
| Código | Descrição |
|---|---|
200 | O automático atualizado. |
400 | Requisição inválida — falha de validação. |
401 | Token ausente, inválido ou expirado. |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
422 | Consentimento ausente ao ligar, dia, hora ou blocos inválidos. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X PUT "https://api.memberfy.net/api/campaigns/automatic/<systemKey>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'