Skip to content
memberfy
US

Cria um rascunho de campanha

POST/api/campaigns

Auth
Requires a token
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.

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

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
namerequiredstringmax 200
subjectrequiredstringmax 300
preheaderoptionalstringmax 300
blocksoptionalobject[]
blocks[].typerequiredtext | button | image
blocks[].htmloptionalstringSó em `text`. HTML rico, sanitizado como nos posts. `{{nome}}` vira o primeiro nome de cada pessoa.
blocks[].textoptionalstringSó em `button`. · max 80
blocks[].urloptionalstringEm `button` (destino) e `image` (endereço da imagem). Só http ou https.
blocks[].altoptionalstringSó em `image`. · max 200
audienceoptionalobjectPúblico: a união de todos os critérios, cada pessoa uma vez. Quem se descadastrou, teve bounce permanente ou reclamou nunca entra.
audience.alloptionalbooleanToda a base da comunidade.
audience.groupIdsoptionalstring (uuid)[]
audience.tagsoptionalstring[]Nomes das tags.
audience.profileIdsoptionalstring (uuid)[]Pessoas escolhidas na mão. Quem se descadastrou é recusado com erro no campo `audience.profileIds`.

Responses

StatusDescription
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.

curl example

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