Documentação para desenvolvedores do SendHQ

Infraestrutura de e-mail com resultados explícitos.

Verifique um domínio, envie e-mails esperados, receba respostas, publique templates tipados e inspecione a entrega sem esconder o estado do provedor.

Enviar um e-mail
curl https://sendhq.cc/api/v1/emails \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: welcome-user-42" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome","text":"Your workspace is ready."}'

Escolha um caminho

Comece pela tarefa que você precisa entregar.

Guias do produto

Acompanhe o sistema completo, não apenas uma requisição isolada.

Comece aqui

Início rápido

Crie uma chave, verifique um domínio e envie um e-mail controlado com uma requisição segura para novas tentativas.

Comece aqui

Migrar do Resend

Mapeie os envios HTTP do Resend para o SendHQ e considere os limites de compatibilidade antes da virada.

Start here

Migrate from SendGrid

Move SendGrid Mail Send, dynamic templates, Event Webhook, suppressions, and Inbound Parse to the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from Mailgun

Move Mailgun Messages API sends, templates, webhooks, suppressions, and Routes to the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from Postmark

Move Postmark Email API sends, message streams, templates, webhooks, suppressions, and inbound processing to the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from Amazon SES

Move Amazon SES SendEmail calls, configuration-set events, the account suppression list, templates, and receipt rules to the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from AgentMail

Move AgentMail inboxes, sends, replies, threads, labels, and message webhooks for AI agents to SendHQ inboxes and the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from Mailtrap

Move Mailtrap Email Sending API calls, webhooks, and suppressions to the SendHQ API, with a prompt your coding agent can run.

Start here

Migrate from Brevo

Move Brevo transactional email API sends, templates, webhooks, and blocked contacts to the SendHQ API, with a prompt your coding agent can run.

Start here

Use SendHQ with ShipFast

Send ShipFast's sendEmail() and NextAuth magic-link emails through the SendHQ API instead of Resend and SMTP, with a prompt your coding agent can run.

Comece aqui

Autenticação

Use chaves de API no lado do servidor para integrações do produto e sessões de navegador para a administração do workspace.

Comece aqui

Erros e novas tentativas

Faça o parsing do envelope de erro JSON padrão e decida quando uma nova tentativa é segura.

Comece aqui

Versionamento e descontinuação

Entenda as versões principais na URL, adições compatíveis, avisos de descontinuação e janelas de desativação.

Enviar

Envio de e-mails

Envie mensagens transacionais, lotes, respostas, anexos e templates hospedados com segurança.

Enviar

Domínios e DNS

Provision sender identities and interpret DNS, propagation, and repair states.

Enviar

Templates hospedados

Crie rascunhos tipados, pré-visualize o resultado exato, publique versões imutáveis e preserve a procedência dos envios.

Send

Newsletters and campaigns

Keep consented contacts, target segments, write, test, schedule, and send broadcasts, read bot-filtered open and click reports, and publish a newsletter site.

Send

Events and connections

Tell SendHQ what your contacts do, from your own code, from a payment provider's webhook, or from a spreadsheet, and see what came in and which automations it started.

Receber

E-mail de entrada

Crie caixas de entrada, receba mensagens roteadas, retenha anexos e monte conversas em ordem cronológica.

Receber

Marcadores e categorias

Arquive automaticamente e-mails enviados e recebidos em marcadores e dê a um agente uma categoria da qual suas conversas nunca saem.

Receber

Spam, atualizações e importância

Como o SendHQ classifica os e-mails recebidos em principal, atualizações e spam, sinaliza mensagens importantes e aprende com as correções.

Operar

Entregabilidade

Entenda os eventos do provedor, a reputação por identidade de remetente, o aumento gradual diário e a recuperação automática.

Operar

Supressões e opt-outs

Evite entregas inseguras a destinatários com bounce, reclamação ou descadastro.

Operate

Webhooks

Receive signed email events (sent, delivered, delayed, bounced, complained, failed, received) at your own HTTPS endpoint, with retries.

Operar

Cobrança e limites

Understand the subscription requirement, the daily sending ramp, recipient credits, attachment transfer, and webhook-driven entitlements.

Tools

Command-line interface

Install the SendHQ CLI to send and read email, verify domains, manage inboxes and templates, and run the MCP server from a terminal, a script, or CI.

Integrations

Supabase Auth emails

Send Supabase sign-up, magic link, password reset, and email change messages through SendHQ with Supabase's Send Email hook and an Edge Function.

Contrato legível por máquina

OpenAPI 3.1, gerado a partir do mesmo catálogo destas páginas.

Use a especificação para clientes, testes, descoberta e ferramentas de agentes.

Abrir a especificaçãoVer os endpoints