Referência
Versionamento
A API do Emailit está na versão 2. Como a versão é definida, o que muda sem uma nova versão, a API v1 descontinuada e a mudança para IDs de objeto com prefixo.
A versão da API faz parte da URL base, então toda requisição indica a versão para a qual foi escrita. Esta página explica quais versões existem, o que pode mudar dentro de uma versão e como os IDs de objeto mudaram em 2026.
Versões
| Versão | URL base | Status |
|---|---|---|
| v2 | https://api.emailit.com/v2 |
Atual. Lançada em outubro de 2025. Tudo nesta referência é v2. |
| v1 | https://api.emailit.com/v1 |
Descontinuada. A geração anterior da API. Não recebe novos recursos e não é mais documentada. |
Se você ainda chama a v1, migre a sua integração para a v2. Todos os SDKs usam a v2.
Mudanças dentro da v2
O Emailit faz acréscimos à v2 sem mudar a versão na URL. Estas mudanças podem acontecer a qualquer momento:
- Novos endpoints e recursos.
- Novos parâmetros de requisição e cabeçalhos opcionais.
- Novos campos nos objetos de resposta e nos payloads de webhook.
- Novos tipos de evento, status e outros valores de enum.
Escreva clientes que as tolerem: ignore os campos de resposta que você não reconhece, não falhe diante de um status ou tipo de evento desconhecido e não dependa da ordem dos campos em um objeto JSON.
As mudanças na API são anunciadas no changelog.
IDs de objeto
Em janeiro de 2026, todos os objetos passaram a usar IDs com prefixo: um prefixo de tipo seguido de 27 letras e dígitos, como em_4KYof1ZzXndZE2VPi0DgULiekG8 para um e-mail ou dom_4K468YrjOkR1wwdhqiO0G9XEUey para um domínio. Todos os endpoints recebem e retornam esses IDs. Consulte IDs de objeto para ver todos os prefixos.
- Armazene os IDs como strings e compare-os de forma exata. Eles diferenciam maiúsculas de minúsculas.
- Os domínios de envio que já existiam antes da mudança mantêm IDs que começam com
sd_oused_. Eles funcionam em todos os lugares em que um IDdom_funciona, então não valide IDs de domínio pelo prefixo. - As chaves de API são segredos, não IDs. As chaves novas começam com
secret_, e as chaves mais antigas sem o prefixo continuam funcionando. O ID de uma chave de API começa comkey_.