Referência da API

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.

GET/account
Chave de API

Obter a conta, o uso, o estado de cobrança e as contagens do workspace com uma chave de API

Equivalente ao perfil do painel para chaves de API: o proprietário da conta, o uso de destinatários e anexos no período atual em relação aos limites do plano, o nível de acesso, o resumo da reputação do remetente, o estado da assinatura, os planos publicados e as contagens do workspace. Somente leitura; alterações de cobrança continuam exclusivas da sessão.

Requisição
curl https://sendhq.cc/api/v1/account \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Resposta 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "infrastructure": {},
  "billing": {},
  "plans": [],
  "workspace": {
    "mailer": "ses",
    "stats": {}
  }
}
GET/account/diagnostics
Chave de API

Diagnose sending and receiving problems in the workspace

Read-only troubleshooting snapshot from stored state: an `issues` list in plain language, plan and usage against limits, each domain's DKIM and inbound state, sending identities, 30-day deliverability and sender reputation, suppressions and unsubscribes, the last 30 days of messages that were not sent with their reasons, bounce, complaint and reject events, and webhook delivery health. Never returns message bodies, API keys or webhook secrets.

Requisição
curl https://sendhq.cc/api/v1/account/diagnostics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Resposta 200
{
  "generatedAt": "2026-10-30T12:00:00.000Z",
  "windowDays": 30,
  "issues": [
    {
      "severity": "action",
      "code": "domain_unverified",
      "message": "example.com is not verified (pending); 2 of 3 DKIM records are not visible in DNS yet."
    }
  ],
  "plan": {},
  "domains": [],
  "sendingIdentities": {
    "domains": [],
    "addresses": []
  },
  "inbound": {},
  "deliverability": {},
  "suppressions": {},
  "failures": {
    "notSent": [],
    "recentNotSent": [],
    "recentProviderEvents": []
  },
  "webhooks": []
}
GET/analytics
Chave de API

Obter as análises de envio do painel para 7, 30 ou 90 dias

Totais de enviados, recebidos, entregues, bounces, bloqueados, abertos, clicados e reclamações na janela, uma linha do tempo diária de enviados/recebidos, os principais domínios de envio e os assuntos de melhor desempenho.

Parâmetros de querydays
Requisição
curl https://sendhq.cc/api/v1/analytics \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Resposta 200
{
  "window": "30d",
  "days": 30,
  "metrics": {
    "sent": 0,
    "received": 0,
    "bounced": 0,
    "blocked": 0,
    "delivered": 0,
    "opened": 0,
    "clicks": 0,
    "complaints": 0
  },
  "timeline": [],
  "domains": [],
  "topContent": []
}
GET/profile
Sessão de navegador

Obter a conta, o uso e o estado das assinaturas acumuladas

Obter a conta, o uso e o estado das assinaturas acumuladas

Requisição
curl https://sendhq.cc/api/v1/profile \
  -X GET \
  -H "Cookie: sendhq_session_v2=…"
Resposta 200
{
  "user": {},
  "usage": {},
  "access": {},
  "reputation": {},
  "billing": {},
  "plans": []
}
POST/billing/checkout
Sessão de navegador

Iniciar um checkout hospedado para um plano que você ainda não possui (nível, classe de mensagem e intervalo de cobrança)

Iniciar um checkout hospedado para um plano que você ainda não possui (nível, classe de mensagem e intervalo de cobrança)

Requisição
curl https://sendhq.cc/api/v1/billing/checkout \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"plan_key":"scaleup_marketing_annual"}'
Resposta 200
{
  "url": "https://checkout.example/…",
  "session_id": "…"
}
POST/billing/cancel
Sessão de navegador

Cancelar a assinatura atual no próprio aplicativo sem acionar o provedor

Cancelar a assinatura atual no próprio aplicativo sem acionar o provedor

Requisição
curl https://sendhq.cc/api/v1/billing/cancel \
  -X POST \
  -H "Cookie: sendhq_session_v2=…"
Resposta 200
{
  "ok": true
}
POST/keys
Sessão de navegador

Criar uma chave de API

Criar uma chave de API

Requisição
curl https://sendhq.cc/api/v1/keys \
  -X POST \
  -H "Cookie: sendhq_session_v2=…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production"}'
Resposta 201
{
  "id": "key_…",
  "name": "Production",
  "key": "re_…",
  "prefix": "re_…"
}
GET/keys
Chave de API

Listar os metadados das chaves de API

Lista os nomes das chaves, os prefixos não secretos e os carimbos de data e hora do último uso. Os valores completos das chaves nunca são retornados. Criar e revogar chaves exige uma sessão do painel.

Requisição
curl https://sendhq.cc/api/v1/keys \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Resposta 200
{
  "data": [],
  "count": 0
}
DELETE/keys/:id
Sessão de navegador

Revogar uma chave de API

Revogar uma chave de API

Requisição
curl https://sendhq.cc/api/v1/keys/id_value \
  -X DELETE \
  -H "Cookie: sendhq_session_v2=…"
Resposta 200
{
  "ok": true
}