Skip to main content
Cada escopo é uma porta na sua chave: abra só as que a integração precisa, domínio, envio, leitura ou cancelamento.
Cada escopo libera um tipo de operação no E-mail. Use só o que sua integração precisa.

​
Como enviar a chave

Recomendado
Alternativo
A API Key pertence a um workspace. Você não acessa outro workspace com a mesma chave.

​
Combinações comuns

Só enviar

email:send

Enviar e consultar

email:send, email:read

Com agendamento

email:send, email:cancel

Setup completo

email:domains:create, email:domains:list, email:send, email:read

Inbox + webhook

email:inbound:read, webhook email.received
Lista de escopos vazia na criação = acesso ADMIN. Em produção, restrinja sempre.

​
Escopos disponíveis

Enviar e-mail imediato ou agendado. O domínio do from deve estar VERIFIED.
  • Listar enviados do workspace
  • Consultar um envio pelo id
Com domainIds na chave, a listagem fica limitada a esses domínios.
Cancelar e-mail na fila ou agendado. Só com status QUEUED ou SCHEDULED. Créditos são devolvidos.
Listar domínios, ver detalhe e verificar status no DNS.
Registrar novo domínio para verificação DNS.
Listar e consultar e-mails recebidos (inbound) em GET /v1/email/inbound e GET /v1/email/inbound/:id. Requer Persistir ativo no canal. Com domainIds na chave, mesmas restrições de domínio que email:read. Webhook email.received para tempo real.

​
Limite por domínio

Se a chave tiver domainIds configurados:
  • Envio — só remetentes (from) desses domínios (403 DOMAIN_NOT_ALLOWED)
  • Listagem de enviados (email:read) — só mensagens desses domínios
  • Inbound (email:inbound:read) — só e-mails recebidos nesses domínios; domainId inválido → 400; domínio fora da chave → 403; detalhe de outro domínio → 404
Lista vazia = qualquer domínio VERIFIED do workspace.

​
Erros comuns

Confira Authorization: Bearer sk_... e se a chave não foi apagada no painel.
Verifique escopo da rota, domainIds na chave e créditos (PLAN_LIMIT_CREDITS).
Verifique o domínio do from no painel antes de enviar.

​
Próximos passos