Referência
Referência da API
A API REST do Emailit em resumo. URL base, autenticação, requisições e respostas JSON, IDs de objeto, versionamento e todos os recursos que você pode gerenciar.
A API do Emailit é uma API REST servida por HTTPS. Você envia JSON, recebe JSON de volta e autentica cada requisição com um bearer token. Use-a para enviar e-mails e gerenciar todo o resto de um workspace: domínios de envio, chaves de API, contatos, listas de contatos, campanhas, templates, webhooks e mais.
URL base
Toda requisição vai para a URL base da versão 2:
https://api.emailit.com/v2Os caminhos desta referência são relativos a ela. Por exemplo, POST /emails significa POST https://api.emailit.com/v2/emails.
Fazer a primeira requisição
Esta requisição envia um e-mail. Substitua o remetente por um endereço de um domínio de envio verificado e defina EMAILIT_API_KEY como uma das suas chaves de API.
curl https://api.emailit.com/v2/emails \
-H "Authorization: Bearer $EMAILIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"from": "Acme <hello@acme.com>",
"to": "ada@example.com",
"subject": "Welcome to Acme",
"html": "<p>Thanks for signing up.</p>"
}'import { Emailit } from '@emailit/node';
const emailit = new Emailit(process.env.EMAILIT_API_KEY);
const email = await emailit.emails.send({
from: 'Acme <hello@acme.com>',
to: 'ada@example.com',
subject: 'Welcome to Acme',
html: '<p>Thanks for signing up.</p>',
});import os
from emailit import EmailitClient
client = EmailitClient(os.environ["EMAILIT_API_KEY"])
email = client.emails.send({
"from": "Acme <hello@acme.com>",
"to": "ada@example.com",
"subject": "Welcome to Acme",
"html": "<p>Thanks for signing up.</p>",
})A resposta é o novo objeto de e-mail, com o ID dele (em_…) e o status accepted. Consulte Enviar um e-mail para ver todas as opções.
Autenticação
Passe uma chave de API ou um token de acesso OAuth no cabeçalho Authorization:
Authorization: Bearer secret_••••••••••••••••••••••••••••••••As chaves de API começam com secret_ e pertencem a um workspace. Uma chave tem o escopo full (todos os endpoints) ou o escopo sending (apenas os endpoints de envio), e uma chave de envio pode ser restrita a um domínio de envio. Requisições sem uma chave válida falham com 401. Consulte Autenticação.
Requisições e respostas
- JSON na entrada, JSON na saída. Envie o corpo das requisições como JSON, com
Content-Type: application/json. Um corpo que não é um JSON válido retorna400com a mensagemInvalid JSON in request body. O tamanho máximo do corpo da requisição é 50 MB. - Métodos.
GETlê,POSTcria e atualiza, eDELETEexclui. A API não usaPUTnemPATCH. - Objetos. Todo objeto tem um campo
objectque indica o tipo dele (email,domain,api_key,audience,subscriber,contact, …) e umid. - Timestamps. As datas são strings ISO 8601 em UTC com precisão de microssegundos, por exemplo
2026-10-01T09:30:12.482913Z. Campos sem valor sãonull. - Listas. Os endpoints de listagem são paginados, e a maioria aceita filtros e ordenação. Consulte Paginação e Filtragem.
- Erros. Requisições com falha retornam um código de status
4xxou5xxe um corpo JSON que explica o problema. Consulte Erros.
IDs de objeto
Os IDs são strings formadas por um prefixo de tipo e 27 letras e dígitos, por exemplo em_4KYof1ZzXndZE2VPi0DgULiekG8. Os IDs diferenciam maiúsculas de minúsculas e seguem aproximadamente a ordem de criação.
| Prefixo | Objeto | Prefixo | Objeto |
|---|---|---|---|
em_ |
aud_ |
Lista de contatos | |
dom_ |
Domínio de envio | sub_ |
Inscrito |
key_ |
Chave de API | con_ |
Contato |
tem_ |
Template | cmp_ |
Campanha |
sup_ |
Supressão | frm_ |
Formulário |
wh_ |
Webhook | fsub_ |
Resposta de formulário |
whr_ |
Requisição de webhook | aut_ |
Automação |
evt_ |
Evento | aur_ |
Execução de automação |
dmr_ |
Relatório DMARC | ev_ |
Verificação de e-mail |
evl_ |
Lista de verificação |
Alguns recursos também aceitam um identificador legível no caminho. Domínios, chaves de API, listas de contatos, campanhas e webhooks aceitam o nome (GET /domains/acme.com). Contatos e supressões aceitam um endereço de e-mail, e inscritos aceitam o endereço de e-mail do contato. Codifique para URL os nomes e endereços que contêm caracteres especiais. Domínios criados antes da mudança para IDs dom_ mantêm o ID sd_ ou sed_, e esses IDs continuam funcionando.
Versionamento
A versão atual é a v2, e ela faz parte da URL base. Novos campos e endpoints são adicionados à v2 sem mudança de versão, então escreva clientes que ignorem os campos que não reconhecem. Consulte Versionamento.
Recursos
Para ver em uma única tabela todos os endpoints e o escopo que cada um exige, consulte Todos os endpoints.
SDKs
Bibliotecas oficiais encapsulam a API nas linguagens mais comuns. Elas têm código aberto no GitHub.
| Linguagem | Pacote | Guia |
|---|---|---|
| Node.js | @emailit/node |
Node.js |
| Python | emailit |
Python |
| PHP | emailit/emailit-php |
PHP |
| Laravel | emailit/emailit-laravel |
Laravel |
| Ruby | emailit |
Ruby on Rails |
| Go | github.com/emailit/emailit-go/v2 |
Go |
| Java | com.emailit |
Java |
| .NET | Emailit |
.NET |
| Rust | emailit |
SDKs |
Webhooks e eventos
Em vez de consultar periodicamente as mudanças de status, registre um webhook, e o Emailit envia lotes assinados de eventos para o seu endpoint à medida que eles acontecem: entregas, bounces, aberturas, cliques, novos contatos e mais. Os mesmos eventos estão disponíveis em Listar eventos. Consulte Tipos de evento para ver a lista completa.
Servidor MCP
O servidor MCP hospedado em https://api.emailit.com/mcp permite que assistentes de IA como ChatGPT, Claude, Cursor, Codex e Grok chamem esta API por você: 109 ferramentas cobrem todos os recursos desta página. Os assistentes fazem login com OAuth ou usam uma chave de API, com os mesmos escopos. Consulte Servidor MCP e a referência de ferramentas.