Envia agora
POST/api/campaigns/{id}/send
- 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). **Manda e-mail em volume para as pessoas do público.** Exige `consent: true` (a confirmação de que são membros da comunidade e aceitam receber comunicados) na primeira vez. Tudo o que pode ser recusado é recusado antes de criar qualquer envio: variável que não existe no texto (400), assunto ou conteúdo vazio (422), público vazio ou acima de 20.000 pessoas (422) e cota estourada (429, dizendo qual limite e quando libera). Enquanto a comunidade não tem nenhum disparo concluído, o público é limitado a 500 pessoas (422 `firstSendLimit`). Se os bounces permanentes passarem de 5% ou as reclamações de 0,3% (com pelo menos 50 enviados), a campanha é pausada sozinha e os owners são avisados. Quem se descadastrou, teve bounce permanente ou reclamou fica de fora. O envio sai em lotes pela fila, abaixo do e-mail de sistema, e o retorno (202) traz o disparo; acompanhe os contadores em `GET /api/campaigns/{id}`. Cada e-mail leva o link de descadastro e os cabeçalhos `List-Unsubscribe`. Aberturas e cliques são sempre medidos.
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 |
|---|---|---|
consentfacultatif | boolean | Obrigatório `true` no primeiro envio da campanha. |
Réponses
| Statut | Description |
|---|---|
202 | Envio aceito; as linhas entram na fila em lotes. |
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 | A campanha não é mais rascunho (já foi enviada). |
422 | Consentimento, assunto, conteúdo ou público ausentes; público vazio ou grande demais. |
429 | Cota de disparos do dia, da semana ou do mês esgotada, ou o público passa dos destinatários de e-mail que sobram no período (`quota_recipients`). |
500 | Erro interno do servidor. |
Exemple curl
curl -X POST "https://api.memberfy.net/api/campaigns/<id>/send" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'