Referencia de la API

Correos e hilos

Envíe, recupere, busque y responda correos, e inspeccione los eventos de entrega.

POST/emails
Clave de API

Enviar un correo

Envíe contenido transaccional en HTML, texto o plantilla alojada desde un dominio verificado del espacio de trabajo. Los envíos directos pueden establecer message_class en marketing cuando está habilitado para el dominio del remitente verificado. Marketing agrega encabezados de baja gestionados, salvo que una integración propia configurada proporcione su propia URL visible HTTPS de baja con un clic.

Encabezados opcionalesIdempotency-Key
Solicitud
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."}'
Respuesta 201
{
  "id": "em_…",
  "providerMessageId": "provider-id",
  "threadId": "em_…"
}
POST/emails/batch
Clave de API

Enviar hasta 100 mensajes personalizados

Enviar hasta 100 mensajes personalizados

Encabezados opcionalesIdempotency-Key
Solicitud
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."}]}'
Respuesta 201
{
  "data": [
    {
      "index": 0,
      "ok": true,
      "id": "em_…"
    }
  ],
  "count": 1,
  "successful": 1,
  "failed": 0
}
GET/emails
Clave de API

Listar el correo enviado y recibido

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
Solicitud
curl https://sendhq.cc/api/v1/emails \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "data": [],
  "count": 0
}
GET/emails/:id
Clave de API

Obtener un correo y sus adjuntos

Obtener un correo y sus adjuntos

Solicitud
curl https://sendhq.cc/api/v1/emails/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "id": "em_…",
  "direction": "out",
  "status": "sent",
  "attachments": []
}
PATCH/emails/:id
Clave de API

Actualizar leído, archivado, spam, categoría o importancia

Establezca `read`, `archived`, `category` (`primary`, `updates` o `spam`; solo correo recibido) e `important`. Cambiar `category` o `important` enseña a SendHQ sobre el remitente: el spam notificado envía el correo futuro de ese remitente a spam, `Not spam` anula las comprobaciones automáticas de spam para él, y la importancia queda asociada al remitente. Pase `learn: false` para cambiar solo este mensaje.

Solicitud
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"}'
Respuesta 200
{
  "id": "em_…",
  "readAt": "2026-08-23T12:00:00.000Z",
  "archivedAt": null,
  "category": "spam",
  "important": false,
  "classification": "you moved it here"
}
DELETE/emails/:id
Clave de API

Eliminar un correo conservado

Eliminar un correo conservado

Solicitud
curl https://sendhq.cc/api/v1/emails/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "ok": true
}
GET/emails/:id/events
Clave de API

Listar los eventos de entrega de un correo

Listar los eventos de entrega de un correo

Solicitud
curl https://sendhq.cc/api/v1/emails/id_value/events \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "data": [],
  "count": 0
}
GET/threads/:id
Clave de API

Obtener una conversación en orden cronológico

Obtener una conversación en orden cronológico

Solicitud
curl https://sendhq.cc/api/v1/threads/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "id": "em_…",
  "data": [],
  "count": 0
}
GET/emails/:id/delivery
Clave de API

Delivery timeline for one email, with bounce and complaint reasons

Delivery timeline for one email, with bounce and complaint reasons

Solicitud
curl https://sendhq.cc/api/v1/emails/id_value/delivery \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"
Respuesta 200
{
  "emailId": "em_123",
  "status": "bounced",
  "timeline": [],
  "count": 0,
  "limit": 50,
  "offset": 0
}
GET/threads/:id/delivery
Clave de API

Per-thread delivery counts and per-message failure reasons

Per-thread delivery counts and per-message failure reasons

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