Prévia do público
POST/api/campaigns/{id}/audience-preview
- Auth
- Requires a token
- X-CommunityId
X-CommunityIdSend 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.
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`).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
audienceoptional | 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.alloptional | boolean | Toda a base da comunidade. |
audience.groupIdsoptional | string (uuid)[] | |
audience.tagsoptional | string[] | Nomes das tags. |
audience.profileIdsoptional | string (uuid)[] | Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`. |
Responses
| Status | Description |
|---|---|
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. |
curl example
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 '{}'