Référence de l’API

E-mails et fils de discussion

Envoyez, récupérez et recherchez des e-mails, répondez-y et consultez leurs événements de livraison.

POST/emails
Clé API

Envoyer un e-mail

Envoie du contenu transactionnel HTML, texte ou issu d’un modèle hébergé depuis un domaine vérifié de l’espace de travail. Les envois directs peuvent définir message_class sur marketing lorsque cette option est activée pour le domaine d’expéditeur vérifié. Le mode marketing ajoute des en-têtes de désinscription gérés, sauf si une intégration first-party configurée fournit sa propre URL HTTPS visible de désinscription en un clic.

En-têtes facultatifsIdempotency-Key
Requête
curl https://sendhq.cc/api/v1/emails \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}'
Réponse 201
{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}
POST/emails/batch
Clé API

Envoyer jusqu’à 100 messages personnalisés

Envoyer jusqu’à 100 messages personnalisés

En-têtes facultatifsIdempotency-Key
Requête
curl https://sendhq.cc/api/v1/emails/batch \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":[{"from":"Acme <hello@example.com>","to":["customer@example.net"],"subject":"Welcome aboard","html":"<h1>Welcome</h1><p>Your workspace is ready.</p>","text":"Welcome. Your workspace is ready."}]}'
Réponse 201
{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}
GET/emails
Clé API

Lister les e-mails envoyés et reçus

Newest-first list with filters. `query` searches subjects, bodies, participants, and attachment filenames. `label`, `domain`, and `category` accept one value or a comma-separated list (matches any); labels may be IDs or names. `outcome` filters sent mail to `bounced`, `complained`, `failed`, or `rejected` (comma-separated, matches any). `archived=false` returns the Inbox view for received mail. Received mail is classified as `primary`, `updates` (newsletters, bulk, and automated mail), or `spam`, and flagged `important`; spam is excluded unless `category=spam` or `include_spam=true`.

Query parametersdirectionstatusoutcomedomaininbox_idlabelarchivedcategoryimportantinclude_spamfromtounreadafterbeforequerylimitoffset
Requête
curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "data": [],
  "count": 0
}
GET/emails/:id
Clé API

Récupérer un e-mail et ses pièces jointes

Récupérer un e-mail et ses pièces jointes

Requête
curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}
PATCH/emails/:id
Clé API

Modifier l’état lu, l’archivage, le spam, la catégorie ou l’importance

Définissez `read`, `archived`, `category` (`primary`, `updates` ou `spam`, courrier reçu uniquement) et `important`. Modifier `category` ou `important` renseigne SendHQ sur l’expéditeur : signaler un spam envoie les futurs e-mails de cet expéditeur dans le spam, `Not spam` désactive pour lui les contrôles automatiques de spam, et l’importance reste attachée à l’expéditeur. Passez `learn: false` pour ne modifier que ce message.

Requête
curl https://sendhq.cc/api/v1/emails/id_value \
  -X PATCH \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"category":"spam"}'
Réponse 200
{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}
DELETE/emails/:id
Clé API

Supprimer un e-mail conservé

Supprimer un e-mail conservé

Requête
curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "ok": true
}
GET/emails/:id/events
Clé API

Lister les événements de livraison d’un e-mail

Lister les événements de livraison d’un e-mail

Requête
curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "data": [],
  "count": 0
}
GET/threads/:id
Clé API

Récupérer une conversation dans l’ordre chronologique

Récupérer une conversation dans l’ordre chronologique

Requête
curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "id": "em_…",
  "data": [],
  "count": 0
}
GET/emails/:id/delivery
Clé API

Delivery timeline for one email, with bounce and complaint reasons

Delivery timeline for one email, with bounce and complaint reasons

Requête
curl https://sendhq.cc/api/v1/emails/id_value/delivery \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "emailId": "em_123",
  "status": "bounced",
  "timeline": [],
  "count": 0,
  "limit": 50,
  "offset": 0
}
GET/threads/:id/delivery
Clé API

Per-thread delivery counts and per-message failure reasons

Per-thread delivery counts and per-message failure reasons

Requête
curl https://sendhq.cc/api/v1/threads/id_value/delivery \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Réponse 200
{
  "threadId": "thr_123",
  "delivered": 0,
  "bounced": 0,
  "complained": 0,
  "failed": 0,
  "messages": []
}