Referencia de la API
Cuenta y facturación
Lea el uso de la cuenta, las analíticas y los metadatos de las claves con una clave de API; los cambios de facturación y la creación o revocación de claves requieren una sesión del panel.
Ninguna operación coincide con este filtro.
/accountObtener la cuenta, el uso, el estado de facturación y el número de espacios de trabajo con una clave de API
Equivalente con clave de API del perfil del panel: el titular de la cuenta, el uso de destinatarios y adjuntos del periodo actual frente a los límites del plan, el nivel de acceso, el resumen de reputación del remitente, el estado de la suscripción, los planes publicados y el número de espacios de trabajo. Solo lectura; los cambios de facturación siguen requiriendo una sesión.
curl https://sendhq.cc/api/v1/account \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"infrastructure": {},
"billing": {},
"plans": [],
"workspace": {
"mailer": "ses",
"stats": {}
}
}/account/diagnosticsDiagnose 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.
curl https://sendhq.cc/api/v1/account/diagnostics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"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": []
}/analyticsObtener las analíticas de envío del panel para 7, 30 o 90 días
Totales de enviados, recibidos, entregados, rebotados, bloqueados, abiertos, clics y quejas en el periodo, una cronología diaria de enviados/recibidos, los principales dominios de envío y los asuntos con mejor rendimiento.
curl https://sendhq.cc/api/v1/analytics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"window": "30d",
"days": 30,
"metrics": {
"sent": 0,
"received": 0,
"bounced": 0,
"blocked": 0,
"delivered": 0,
"opened": 0,
"clicks": 0,
"complaints": 0
},
"timeline": [],
"domains": [],
"topContent": []
}/profileObtener la cuenta, el uso y el estado de las suscripciones acumuladas
Obtener la cuenta, el uso y el estado de las suscripciones acumuladas
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutIniciar una página de pago alojada para un plan que aún no se tiene (nivel, clase de mensaje e intervalo de facturación)
Iniciar una página de pago alojada para un plan que aún no se tiene (nivel, clase de mensaje e intervalo de facturación)
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"}'{
"url": "https://checkout.example/…",
"session_id": "…"
}/billing/cancelCancelar la suscripción actual desde la aplicación sin tocar el proveedor
Cancelar la suscripción actual desde la aplicación sin tocar el proveedor
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysCrear una clave de API
Crear una clave de API
curl https://sendhq.cc/api/v1/keys \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'{
"id": "key_…",
"name": "Production",
"key": "re_…",
"prefix": "re_…"
}/keysListar los metadatos de las claves de API
Lista los nombres de las claves, los prefijos no secretos y las marcas de tiempo del último uso. Los valores completos de las claves nunca se devuelven. Crear y revocar claves requiere una sesión del panel.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idRevocar una clave de API
Revocar una clave de API
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}