Référence de l’API

Un seul contrat pour toute la surface client.

Les endpoints client sont disponibles sous /api/v1. L’ancien préfixe /api reste disponible pour le tableau de bord, mais les nouvelles intégrations serveur doivent utiliser l’URL de base versionnée.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

Périmètres d’authentification

Les intégrations produit utilisent une clé API d’espace de travail, qui permet aussi de lire l’usage du compte, les analyses et les métadonnées des clés API. Les modifications de facturation ainsi que la création ou la révocation de clés API exigent la session navigateur HTTP-only et sont signalées comme telles.

Ressources

10 operations

E-mails et fils

Envoyez, récupérez, recherchez, répondez et inspectez les événements de livraison.

8 opérations

Libellés et règles de classement

Organisez le courrier envoyé et reçu en dossiers, automatiquement ou manuellement.

9 opérations

Brouillons et pièces jointes

Construisez des parcours de rédaction avec un stockage privé des pièces jointes.

10 opérations

Modèles hébergés

Rédigez, affichez le rendu, testez, versionnez, publiez et envoyez du contenu réutilisable.

7 opérations

Domaines

Provisionnez des identités d’envoi et comprenez l’état de la vérification DNS.

8 opérations

E-mails entrants

Créez des adresses et travaillez avec les conversations reçues.

9 operations

Délivrabilité

Inspectez les événements, les effets sur la réputation et les destinataires bloqués.

10 operations

Webhooks

Receive signed, retried email events (sent, delivered, delayed, bounced, complained, failed, received) at your own endpoints.

47 operations

Campaigns

Store contacts with their consent basis, tags, and custom fields, organize them into lists with hosted double opt-in signup forms, welcome emails, and public newsletter sites, target segments, import and export CSV files, and send, test, and schedule broadcasts with merge tags, per-list one-click unsubscribe, pre-send checks, bot-filtered open and click reports, and per-recipient outcomes.

36 operations

Automations

Record what contacts do as events, and run timed sequences of emails that start on an event, stop when the contact converts, and share per-person sending limits. Create and edit automations, their emails and language versions, turn them on and off, and add or remove people. Available to enabled workspaces.

9 operations

Compte et facturation

Lisez l’usage du compte, les analyses et les métadonnées des clés avec une clé API ; les modifications de facturation ainsi que la création ou la révocation de clés exigent une session du tableau de bord.

Enveloppe d’erreur

Les erreurs JSON utilisent une enveloppe unique et prévisible. Les codes de statut distinguent entrée invalide, authentification, ressources introuvables, conflits, paiement requis, blocages de sécurité et limites d’usage.

Réponse d’erreur
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versionnage

La version de l’API, basée sur une date, identifie ce contrat. Des champs rétrocompatibles peuvent être ajoutés au sein de la version. Les changements incompatibles exigent un nouveau chemin de base versionné et une transition documentée.

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