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.

63 operações documentadas8 grupos de recursosOpenAPI 3.1 contrato legível por máquina

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

8 operações

E-mails e threads

Envie, obtenha, pesquise, responda e inspecione eventos de entrega.

8 operações

Marcadores e regras de arquivamento

Organize e-mails enviados e recebidos em pastas, automaticamente ou à mão.

9 operações

Rascunhos e anexos

Crie fluxos de composição com armazenamento privado de anexos.

10 operações

Templates hospedados

Crie rascunhos, renderize, teste, versione, publique e envie conteúdo reutilizável.

7 operações

Domínios

Provisione identidades de remetente e entenda o estado da verificação de DNS.

8 operações

E-mail de entrada

Crie endereços e trabalhe com as conversas recebidas.

5 operações

Entregabilidade

Inspecione eventos, resultados de reputação e destinatários bloqueados.

8 operações

Conta 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.

Resposta de erro
{
  "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.

Descoberta
{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}