Referência
Todos os endpoints
Todos os endpoints da API v2 do Emailit em um só lugar, agrupados por recurso, com o método HTTP, o caminho, o escopo de chave de API exigido e um link para a referência de cada um.
Esta página lista todos os endpoints da API do Emailit, agrupados por recurso. Os caminhos são relativos à URL base https://api.emailit.com/v2, e {id} representa o ID do objeto (ou, quando o endpoint permite, o nome ou o endereço de e-mail dele).
A coluna Escopo mostra quais chaves de API podem chamar o endpoint:
| Escopo | Funciona com |
|---|---|
sending |
Chaves com o escopo sending ou full. |
full |
Apenas chaves com o escopo full. |
Os tokens de acesso OAuth seguem as mesmas regras das chaves de API com o mesmo escopo.
E-mails
Envie e-mails, consulte as mensagens e o conteúdo delas, e agende, cancele, tente de novo ou encaminhe envios. Consulte E-mails para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Enviar um e-mail | POST |
/emails |
sending |
| Listar e-mails | GET |
/emails |
full |
| Obter um e-mail | GET |
/emails/{id} |
full |
| Obter o MIME bruto | GET |
/emails/{id}/raw |
full |
| Listar anexos | GET |
/emails/{id}/attachments |
full |
| Obter o corpo | GET |
/emails/{id}/body |
full |
| Obter os metadados | GET |
/emails/{id}/meta |
full |
| Atualizar um e-mail agendado | POST |
/emails/{id} |
sending |
| Cancelar um e-mail | POST |
/emails/{id}/cancel |
sending |
| Tentar enviar um e-mail de novo | POST |
/emails/{id}/retry |
sending |
| Encaminhar um e-mail | POST |
/emails/{id}/forward |
sending |
| Obter apenas o status | GET |
/email/{id} |
full |
Domínios
Adicione domínios de envio, consulte os registros DNS e o status de verificação deles, e verifique-os. Consulte Domínios para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar um domínio | POST |
/domains |
full |
| Obter um domínio | GET |
/domains/{id} |
full |
| Verificar um domínio | POST |
/domains/{id}/verify |
full |
| Atualizar um domínio | POST |
/domains/{id} |
full |
| Listar domínios | GET |
/domains |
full |
| Excluir um domínio | DELETE |
/domains/{id} |
full |
Relatórios DMARC
Consulte os relatórios DMARC agregados e forenses de um domínio de envio ou envie os seus próprios. Consulte Relatórios DMARC para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Listar relatórios agregados | GET |
/domains/{id}/dmarc/reports |
full |
| Obter um relatório | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Enviar um relatório | POST |
/domains/{id}/dmarc/reports |
full |
| Listar relatórios forenses | GET |
/domains/{id}/dmarc/forensic |
full |
| Obter um relatório forense | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Obter estatísticas | GET |
/domains/{id}/dmarc/stats |
full |
| Listar fontes de envio | GET |
/domains/{id}/dmarc/sources |
full |
| Listar países | GET |
/domains/{id}/dmarc/countries |
full |
| Listar redes (ASNs) | GET |
/domains/{id}/dmarc/asns |
full |
| Listar emissores | GET |
/domains/{id}/dmarc/reporters |
full |
Chaves de API
Crie, liste, renomeie e revogue as chaves de API de um workspace. Consulte Chaves de API para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma chave de API | POST |
/api-keys |
full |
| Obter uma chave de API | GET |
/api-keys/{id} |
full |
| Listar chaves de API | GET |
/api-keys |
full |
| Atualizar uma chave de API | POST |
/api-keys/{id} |
full |
| Regenerar uma chave de API | POST |
/api-keys/{id}/regenerate |
full |
| Excluir uma chave de API | DELETE |
/api-keys/{id} |
full |
Listas de contatos
Gerencie as listas de inscritos usadas por campanhas e formulários de inscrição. Consulte Listas de contatos para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma lista de contatos | POST |
/audiences |
full |
| Obter uma lista de contatos | GET |
/audiences/{id} |
full |
| Atualizar uma lista de contatos | POST |
/audiences/{id} |
full |
| Listar listas de contatos | GET |
/audiences |
full |
| Excluir uma lista de contatos | DELETE |
/audiences/{id} |
full |
Inscritos
Adicione, atualize e remova os inscritos de uma lista de contatos. Consulte Inscritos para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Adicionar um inscrito | POST |
/audiences/{audience_id}/subscribers |
full |
| Obter um inscrito | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Atualizar um inscrito | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Listar inscritos | GET |
/audiences/{audience_id}/subscribers |
full |
| Excluir um inscrito | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Contatos
Gerencie perfis de contato e campos personalizados, em massa ou um por vez. Consulte Contatos para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar um contato | POST |
/contacts |
full |
| Obter um contato | GET |
/contacts/{id} |
full |
| Atualizar um contato | POST |
/contacts/{id} |
full |
| Listar contatos | GET |
/contacts |
full |
| Atualizar contatos em massa | POST |
/contacts/bulk |
full |
| Exportar contatos | GET, POST |
/contacts/export |
full |
| Excluir um contato | DELETE |
/contacts/{id} |
full |
Campanhas
Crie campanhas, escolha as listas de contatos delas e envie ou agende o envio. Consulte Campanhas para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma campanha | POST |
/campaigns |
full |
| Obter uma campanha | GET |
/campaigns/{id} |
full |
| Atualizar uma campanha | POST |
/campaigns/{id} |
full |
| Listar campanhas | GET |
/campaigns |
full |
| Enviar ou agendar uma campanha | POST |
/campaigns/{id}/send |
full |
| Cancelar uma campanha | POST |
/campaigns/{id}/cancel |
full |
| Excluir uma campanha | DELETE |
/campaigns/{id} |
full |
Automações
Monte fluxos com gatilhos e etapas, execute-os e inspecione as execuções. Consulte Automações para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma automação | POST |
/automations |
full |
| Obter uma automação | GET |
/automations/{id} |
full |
| Atualizar uma automação | POST |
/automations/{id} |
full |
| Listar automações | GET |
/automations |
full |
| Excluir uma automação | DELETE |
/automations/{id} |
full |
| Iniciar uma automação | POST |
/automations/{id}/start |
full |
| Pausar uma automação | POST |
/automations/{id}/pause |
full |
| Interromper uma automação | POST |
/automations/{id}/stop |
full |
| Disparar uma execução | POST |
/automations/{id}/trigger |
full |
| Listar execuções | GET |
/automations/{id}/runs |
full |
| Obter uma execução | GET |
/automations/{id}/runs/{run_id} |
full |
| Obter estatísticas | GET |
/automations/{id}/stats |
full |
| Obter estatísticas das etapas | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Formulários
Crie formulários de inscrição, publique-os e faça a rotação do token público. Consulte Formulários para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar um formulário | POST |
/forms |
full |
| Obter um formulário | GET |
/forms/{id} |
full |
| Atualizar um formulário | POST |
/forms/{id} |
full |
| Listar formulários | GET |
/forms |
full |
| Publicar um formulário | POST |
/forms/{id}/publish |
full |
| Despublicar um formulário | POST |
/forms/{id}/unpublish |
full |
| Redefinir o token público | POST |
/forms/{id}/reset-token |
full |
| Excluir um formulário | DELETE |
/forms/{id} |
full |
Templates
Crie versões de templates, publique uma por alias e use-as ao enviar. Consulte Templates para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar um template | POST |
/templates |
full |
| Obter um template | GET |
/templates/{id} |
full |
| Atualizar um template | POST |
/templates/{id} |
full |
| Listar templates | GET |
/templates |
full |
| Publicar um template | POST |
/templates/{id}/publish |
full |
| Excluir um template | DELETE |
/templates/{id} |
full |
Supressões
Consulte e gerencie os endereços para os quais o Emailit não envia e-mails. Consulte Supressões para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma supressão | POST |
/suppressions |
full |
| Obter uma supressão | GET |
/suppressions/{id} |
full |
| Atualizar uma supressão | POST |
/suppressions/{id} |
full |
| Listar supressões | GET |
/suppressions |
full |
| Excluir uma supressão | DELETE |
/suppressions/{id} |
full |
Webhooks
Registre endpoints que recebem notificações de eventos assinadas. Consulte Webhooks para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar um webhook | POST |
/webhooks |
full |
| Obter um webhook | GET |
/webhooks/{id} |
full |
| Atualizar um webhook | POST |
/webhooks/{id} |
full |
| Listar webhooks | GET |
/webhooks |
full |
| Excluir um webhook | DELETE |
/webhooks/{id} |
full |
| Enviar um evento de teste | POST |
/webhooks/{id}/test |
full |
| Fazer a rotação do segredo de assinatura | POST |
/webhooks/{id}/reset-secret |
full |
| Tentar de novo as requisições com falha | POST |
/webhooks/{id}/retry-failed |
full |
| Tentar de novo uma requisição | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Eventos
Consulte o fluxo de eventos por trás dos webhooks: entregas, bounces, aberturas e mais. Consulte Eventos para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Listar eventos | GET |
/events |
full |
| Obter um evento | GET |
/events/{id} |
full |
Verificação de e-mails
Verifique um único endereço em tempo real. Consulte Verificação de e-mails para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Verificar um endereço | POST |
/email-verifications |
full |
Listas de verificação
Verifique até 10.000 endereços de uma vez e exporte os resultados. Consulte Listas de verificação para a referência completa.
| Endpoint | Método | Caminho | Escopo |
|---|---|---|---|
| Criar uma lista | POST |
/email-verification-lists |
full |
| Listar listas | GET |
/email-verification-lists |
full |
| Obter uma lista | GET |
/email-verification-lists/{id} |
full |
| Listar resultados | GET |
/email-verification-lists/{id}/results |
full |
| Exportar resultados | GET |
/email-verification-lists/{id}/export |
full |