Prévia do público
POST/api/campaigns/{id}/audience-preview
- Auth
- Exige token
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Owner, admin, moderador e financeiro. Conta quem receberia (união dos critérios, cada pessoa uma vez) e quantas ficaram de fora e por quê: `optedOut` (descadastrada), `hardBounce` (bounce permanente) e `complaint` (reclamação). Traz uma amostra de até 10 pessoas com o e-mail mascarado. Sem corpo, usa o público salvo; com `audience`, prevê o que ainda não foi salvo. Acima de `maxRecipients` (20.000) o envio é recusado (`tooLarge`).
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
idobrigatório | path | string (uuid) |
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 |
|---|---|---|
audienceopcional | object | Público: a união de todos os critérios, cada pessoa uma vez. Quem se descadastrou, teve bounce permanente ou reclamou nunca entra. |
audience.allopcional | boolean | Toda a base da comunidade. |
audience.groupIdsopcional | string (uuid)[] | |
audience.tagsopcional | string[] | Nomes das tags. |
audience.profileIdsopcional | string (uuid)[] | Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`. |
Respostas
| Código | Descrição |
|---|---|
200 | Contagem e amostra. |
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. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X POST "https://api.memberfy.net/api/campaigns/<id>/audience-preview" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'