Riferimento API
Account e fatturazione
Leggi utilizzo dell'account, analytics e metadati delle chiavi con una chiave API; le modifiche alla fatturazione e la creazione o revoca delle chiavi richiedono una sessione della dashboard.
Nessuna operazione corrisponde a questo filtro.
/accountRecupera account, utilizzo, stato della fatturazione e conteggi del workspace con una chiave API
Equivalente con chiave API del profilo della dashboard: titolare dell'account, utilizzo di destinatari e allegati nel periodo corrente rispetto ai limiti del piano, livello di accesso, riepilogo della reputazione del mittente, stato dell'abbonamento, piani pubblicati e conteggi del workspace. Sola lettura; le modifiche alla fatturazione restano riservate alla sessione.
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": []
}/analyticsRecupera le analytics di invio della dashboard per 7, 30 o 90 giorni
Totali di email inviate, ricevute, consegnate, in bounce, bloccate, aperte, cliccate e di segnalazioni di spam per l'intervallo, una timeline giornaliera di invii e ricezioni, i principali domini di invio e gli oggetti con le prestazioni migliori.
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": []
}/profileRecupera account, utilizzo e stato degli abbonamenti cumulati
Recupera account, utilizzo e stato degli abbonamenti cumulati
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutAvvia un checkout ospitato per un piano non ancora attivo (livello, classe di messaggi e periodicità di fatturazione)
Avvia un checkout ospitato per un piano non ancora attivo (livello, classe di messaggi e periodicità di fatturazione)
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/cancelAnnulla l'abbonamento corrente dall'app senza intervenire sul provider
Annulla l'abbonamento corrente dall'app senza intervenire sul provider
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysCrea una chiave API
Crea una chiave 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_…"
}/keysElenca i metadati delle chiavi API
Elenca nomi delle chiavi, prefissi non segreti e timestamp dell'ultimo utilizzo. I valori completi delle chiavi non vengono mai restituiti. La creazione e la revoca delle chiavi richiedono una sessione della dashboard.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idRevoca una chiave API
Revoca una chiave API
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}