Saltar para o conteúdo
memberfy
PT

Cria um rascunho de campanha

POST/api/campaigns

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Owner, admin, moderador e financeiro. Cria sempre um rascunho (nada é enviado). `blocks` aceita `text`, `button` e `image`; o HTML de `text` é sanitizado. No assunto e no texto, `{{nome}}` vira o primeiro nome de cada pessoa. Pessoa escolhida na mão que se descadastrou é recusada com erro no campo `audience.profileIds`.

Headers

NomeTipoDescrição
X-CommunityIdopcionalstring (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

NomeTipoDescrição
nameobrigatóriostringmax 200
subjectobrigatóriostringmax 300
preheaderopcionalstringmax 300
blocksopcionalobject[]
blocks[].typeobrigatóriotext | button | image
blocks[].htmlopcionalstringSó em `text`. HTML rico, sanitizado como nos posts. `{{nome}}` vira o primeiro nome de cada pessoa.
blocks[].textopcionalstringSó em `button`. · max 80
blocks[].urlopcionalstringEm `button` (destino) e `image` (endereço da imagem). Só http ou https.
blocks[].altopcionalstringSó em `image`. · max 200
audienceopcionalobjectPúblico: a união de todos os critérios, cada pessoa uma vez. Quem se descadastrou, teve bounce permanente ou reclamou nunca entra.
audience.allopcionalbooleanToda a base da comunidade.
audience.groupIdsopcionalstring (uuid)[]
audience.tagsopcionalstring[]Nomes das tags.
audience.profileIdsopcionalstring (uuid)[]Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`.

Respostas

CódigoDescrição
201Rascunho criado.
400Requisição inválida — falha de validação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
422Bloco inválido, pessoa que não é da comunidade ou que se descadastrou.
500Erro interno do servidor.

Exemplo com curl

curl -X POST "https://api.memberfy.net/api/campaigns" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"Novidades de outubro","subject":"Olá, {{nome}}: o que há de novo"}'