Skip to content

Envia agora

POST/api/campaigns/{id}/send

Auth
Requires a token
Who can call it:
owner
admin
moderator
finance
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

**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: 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). 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.

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request body application/json

NameTypeDescription
consentoptionalbooleanObrigatório `true` no primeiro envio da campanha.

Responses

StatusDescription
202Envio aceito; as linhas entram na fila em lotes.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409A campanha não é mais rascunho (já foi enviada).
422Consentimento, assunto, conteúdo ou público ausentes; público vazio ou grande demais.
429Cota de disparos do dia, da semana ou do mês esgotada.
500Erro interno do servidor.

curl example

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 '{}'