Referencia de la API

Correos e hilos

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

Filtrar correos e hilos

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

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

Lista del más reciente al más antiguo, con filtros. `query` busca en asuntos, cuerpos, participantes y nombres de archivos adjuntos. `label`, `domain` y `category` aceptan un valor o una lista separada por comas (coincide con cualquiera); las etiquetas pueden ser IDs o nombres. `archived=false` devuelve la vista de la bandeja de entrada para el correo recibido. El correo recibido se clasifica como `primary`, `updates` (newsletters, envíos masivos y correo automatizado) o `spam`, y se marca como `important`; el spam se excluye salvo que se indique `category=spam` o `include_spam=true`.

Parámetros de consultadirectionstatusdomaininbox_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

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

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

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

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
}