Referência da API
Um único contrato para toda a superfície voltada ao cliente.
Os endpoints para clientes estão disponíveis em /api/v1. O prefixo legado /api continua disponível para o painel, enquanto novas integrações no servidor devem usar a URL base versionada.
Limites de autenticação
As integrações de produto usam uma chave de API do workspace, que também pode ler o uso da conta, as análises e os metadados das chaves de API. Alterações de cobrança e a criação ou revogação de chaves de API exigem a sessão de navegador somente HTTP e estão rotuladas como tal.
Recursos
E-mails e threads
Envie, obtenha, pesquise, responda e inspecione eventos de entrega.
8 operaçõesMarcadores e regras de arquivamento
Organize e-mails enviados e recebidos em pastas, automaticamente ou à mão.
9 operaçõesRascunhos e anexos
Crie fluxos de composição com armazenamento privado de anexos.
10 operaçõesTemplates hospedados
Crie rascunhos, renderize, teste, versione, publique e envie conteúdo reutilizável.
7 operaçõesDomínios
Provisione identidades de remetente e entenda o estado da verificação de DNS.
8 operaçõesE-mail de entrada
Crie endereços e trabalhe com as conversas recebidas.
9 operationsEntregabilidade
Inspecione eventos, resultados de reputação e destinatários bloqueados.
10 operationsWebhooks
Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.
47 operationsCampaigns
Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.
36 operationsAutomations
Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.
9 operationsConta e cobrança
Leia o uso da conta, as análises e os metadados das chaves com uma chave de API; alterações de cobrança e a criação ou revogação de chaves exigem uma sessão do painel.
Envelope de erro
Os erros em JSON usam um único envelope previsível. Os códigos de status distinguem entrada inválida, autenticação, recursos inexistentes, conflitos, exigências de pagamento, bloqueios de segurança e limites de uso.
{
"error": {
"message": "The sender domain is not verified",
"status": 403
}
}Versionamento
A versão da API baseada em data identifica este contrato. Campos retrocompatíveis podem ser adicionados dentro da versão. Mudanças incompatíveis exigem um novo caminho base versionado e uma transição documentada.
{
"version": "2026-09-07",
"baseUrl": "https://sendhq.cc/api/v1",
"openapi": "https://sendhq.cc/openapi.json"
}