Agenda o envio (uma vez ou recorrente)
POST/api/campaigns/{id}/schedule
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- moderator
- finance
- Clé d’API:
- campaigns:write
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Com o envio da comunidade suspenso pela guarda de reputação, responde 409 com `data: { code: SENDING_SUSPENDED, sendingSuspendedUntil, untilLifted, reason }` e a data do fim na mensagem. **Só owner e admin** (moderador e financeiro recebem 403). **Vai mandar e-mail em volume nos horários marcados.** `scheduleKind` `ONCE` (padrão) usa `sendAt`, a data e a hora no **fuso da comunidade** (`2026-10-20T09:00`; qualquer `Z` ou deslocamento é ignorado: o texto é horário local; passado ou inválido é 422 em `sendAt`). `DAILY` usa `timeOfDay` (`09:00`, hora local). `WEEKLY` usa `weekdays` (0 = domingo a 6 = sábado) e `timeOfDay`. A criação padrão de uma campanha é de envio único; a recorrência é escolha explícita. Aceita rascunho, campanha já agendada (reagenda) ou pausada, e exige `consent: true` na primeira vez. Variável que não existe no texto devolve 400. Nada entra na fila agora: o job de campanhas (a cada 5 minutos) dispara na hora, relê o público e o conteúdo (blocos dinâmicos mostram só o que é novo desde o disparo anterior), confere a cota (consumida no disparo, não aqui) e envia uma só vez. Disparo recorrente sem nada novo é **pulado** e registrado (`SKIPPED`, `noNewContent`); sem cota, pulado e o owner recebe um aviso por e-mail (uma vez por disparo); envio único com mais de 12 horas de atraso também é pulado. Pausar preserva a próxima data. Campanha automática (`kind: AUTOMATIC`) não usa esta rota (409): veja `/api/campaigns/automatic`.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
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 |
|---|---|---|
scheduleKindfacultatif | ONCE | DAILY | WEEKLY | |
sendAtfacultatif | string | Só em ONCE. |
timeOfDayfacultatif | string | Em DAILY e WEEKLY, hora local. |
weekdaysfacultatif | integer[] | Só em WEEKLY (0 = domingo). |
consentfacultatif | boolean |
Réponses
| Statut | Description |
|---|---|
200 | Campanha agendada (status SCHEDULED, com `nextRunAt` em UTC). |
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 | Data inválida ou no passado; consentimento, assunto ou público ausentes. |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/campaigns/<id>/schedule" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'