Liga, desliga e ajusta um e-mail automático
PUT/api/campaigns/automatic/{systemKey}
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- Clé d’API:
- campaigns:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
**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.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
systemKeyobligatoire | path | WEEKLY_DIGEST |
En-têtes
| Nom | Type | Description |
|---|---|---|
X-CommunityIdfacultatif | string (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
| Nom | Type | Description |
|---|---|---|
enabledfacultatif | boolean | |
consentfacultatif | boolean | |
subjectfacultatif | string | max 300 |
introfacultatif | string | |
weekdaysfacultatif | integer[] | |
timeOfDayfacultatif | string | |
blocksfacultatif | posts | courses | events | classifieds[] |
Réponses
| Statut | Description |
|---|---|
200 | O automático atualizado. |
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 | O envio da comunidade está suspenso pela guarda de reputação. `data`: `{ code: SENDING_SUSPENDED, sendingSuspendedUntil, untilLifted, reason }`; a mensagem traz a data do fim. |
422 | Consentimento ausente ao ligar, dia, hora ou blocos inválidos. |
500 | Erro interno do servidor. |
Exemple 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 '{}'