Saltar al contenido
memberfy
AR

Cria um rascunho de campanha

POST/api/campaigns

Auth
Requiere token
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

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

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
nameobligatoriostringmax 200
subjectobligatoriostringmax 300
preheaderopcionalstringmax 300
blocksopcionalobject[]
blocks[].typeobligatoriotext | 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`.

Respuestas

CódigoDescripción
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.

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