Mailzen Developers

Documentação para desenvolvedores

Referência técnica para integrar sua aplicação ao Mailzen: autenticação, recursos da API, webhooks, SDKs e exemplos de código prontos para usar.

Busca completa disponível na documentação interativa

Introdução

Bem-vindo à documentação técnica do Mailzen. Esta área reúne as referências que times de engenharia precisam para integrar contatos, campanhas, automações e outros recursos da plataforma diretamente na sua aplicação.

Se você está buscando uma visão comercial da API — recursos disponíveis, planos e como contratar — consulte a página API. Aqui o foco é técnico: como autenticar, como chamar os endpoints e como lidar com eventos assíncronos via webhooks.

Autenticação

A API do Mailzen usa autenticação por API Key. Cada chave é vinculada à sua conta e deve ser mantida em segredo — nunca exponha uma API Key em código de front-end ou em repositórios públicos.

Gere uma API Key no painel do Mailzen, na área de configurações da conta.
Envie a chave no cabeçalho HTTP Authorization de cada requisição.
Revogue uma chave a qualquer momento no painel — requisições feitas com uma chave revogada passam a ser rejeitadas imediatamente.

Authorization: Bearer SUA_API_KEY

Detalhes de escopos de permissão por chave em documentação futura

API

A API REST do Mailzen organiza os principais recursos da plataforma em endpoints previsíveis, todos autenticados por API Key:

Contacts

Criação, consulta e atualização de contatos.

Lists

Organização de contatos em listas.

Segments

Segmentação dinâmica da base.

Campaigns

Criação e disparo de campanhas.

Templates

Modelos reutilizáveis de e-mail.

Automations

Fluxos automáticos de comunicação.

Forms

Formulários de captura de contatos.

Domains

Domínios de envio verificados.

Ver documentação completa da API →

Webhooks

Webhooks permitem que sua aplicação receba eventos do Mailzen em tempo real, como aberturas de e-mail, cliques ou atualizações de contato, sem precisar consultar a API repetidamente. Configure uma URL de destino e o Mailzen envia uma requisição POST com um payload em JSON sempre que o evento ocorrer.

{
  "event": "campaign.opened",
  "timestamp": "2026-08-19T14:32:10Z",
  "data": {
    "campaign_id": "cmp_123456",
    "contact_id": "cnt_789012",
    "email": "contato@exemplo.com"
  }
}

Lista completa de eventos e configuração de assinatura de webhook em documentação futura

SDKs

SDKs oficiais em desenvolvimento

Enquanto os SDKs oficiais não são lançados, os exemplos desta documentação cobrem chamadas HTTP diretas nas linguagens planejadas para suporte: JavaScript, Python e PHP, além de exemplos em cURL para uso em qualquer ambiente.

Exemplos

Exemplo de listagem de contatos usando sua API Key:

const response = await fetch("https://api.mailzen.com.br/api/v1/contacts", {
  method: "GET",
  headers: {
    "Authorization": "Bearer SUA_API_KEY"
  }
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://api.mailzen.com.br/api/v1/contacts",
    headers={"Authorization": "Bearer SUA_API_KEY"}
)

print(response.json())

<?php

$ch = curl_init("https://api.mailzen.com.br/api/v1/contacts");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SUA_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

curl -X GET "https://api.mailzen.com.br/api/v1/contacts" \
  -H "Authorization: Bearer SUA_API_KEY"

Changelog

Changelog público em breve

Assim que a API estiver disponível em versão pública, as mudanças e novidades de cada versão serão listadas nesta seção.