Riferimento API

Un unico contratto per l'intera superficie rivolta ai clienti.

Gli endpoint per i clienti sono disponibili sotto /api/v1. Il prefisso legacy /api resta disponibile per la dashboard, ma le nuove integrazioni lato server devono usare l'URL di base con versione.

63 operazioni documentate8 gruppi di risorseOpenAPI 3.1 contratto leggibile dalle macchine

Confini dell'autenticazione

Le integrazioni di prodotto usano una chiave API del workspace, che può anche leggere l'utilizzo dell'account, le analytics e i metadati delle chiavi API. Le modifiche alla fatturazione e la creazione o revoca delle chiavi API richiedono la sessione del browser HTTP-only e sono indicate di conseguenza.

Risorse

8 operazioni

Email e thread

Invia, recupera, cerca, rispondi e controlla gli eventi di consegna.

8 operazioni

Etichette e regole di archiviazione

Organizza la posta inviata e ricevuta in cartelle, automaticamente o a mano.

9 operazioni

Bozze e allegati

Costruisci flussi di composizione con archiviazione privata degli allegati.

10 operazioni

Template ospitati

Crea bozze, renderizza, testa, versiona, pubblica e invia contenuti riutilizzabili.

7 operazioni

Domini

Crea identità di invio e interpreta lo stato della verifica DNS.

8 operazioni

Email in entrata

Crea indirizzi e lavora con le conversazioni ricevute.

5 operazioni

Deliverability

Controlla eventi, esiti di reputazione e destinatari bloccati.

8 operazioni

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.

Struttura degli errori

Gli errori JSON usano un'unica struttura prevedibile. I codici di stato distinguono input non valido, autenticazione, risorse mancanti, conflitti, pagamento richiesto, blocchi di sicurezza e limiti di utilizzo.

Risposta di errore
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versioni

La versione dell'API basata sulla data identifica questo contratto. All'interno della versione possono essere aggiunti campi retrocompatibili. Le modifiche incompatibili richiedono un nuovo percorso di base con versione e una transizione documentata.

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