Referencia de la API

Un único contrato para toda la superficie de cliente.

Los endpoints para clientes están disponibles bajo /api/v1. El prefijo heredado /api sigue disponible para el panel, pero las nuevas integraciones de servidor deben usar la URL base con versión.

163 documented operations11 resource groupsOpenAPI 3.1 machine-readable contract

Límites de autenticación

Las integraciones de producto usan una clave de API del espacio de trabajo, que también puede leer el uso de la cuenta, las analíticas y los metadatos de las claves de API. Los cambios de facturación y la creación o revocación de claves de API requieren la sesión del navegador HTTP-only y están etiquetados en consecuencia.

Recursos

10 operations

Correos e hilos

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

8 operaciones

Etiquetas y reglas de archivado

Organice el correo enviado y recibido en carpetas, de forma automática o manual.

9 operaciones

Borradores y adjuntos

Cree flujos de redacción con almacenamiento privado de adjuntos.

10 operaciones

Plantillas alojadas

Redacte, renderice, pruebe, versione, publique y envíe contenido reutilizable.

7 operaciones

Dominios

Aprovisione identidades de remitente y entienda el estado de la verificación DNS.

8 operaciones

Correo entrante

Cree direcciones y trabaje con las conversaciones recibidas.

9 operations

Entregabilidad

Inspeccione eventos, resultados de reputación y destinatarios bloqueados.

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

Cuenta y facturación

Lea el uso de la cuenta, las analíticas y los metadatos de las claves con una clave de API; los cambios de facturación y la creación o revocación de claves requieren una sesión del panel.

Sobre de error

Los errores JSON usan un sobre único y predecible. Los códigos de estado distinguen entrada no válida, autenticación, recursos inexistentes, conflictos, requisitos de pago, bloqueos de seguridad y límites de uso.

Respuesta de error
{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

Versiones

La versión de la API basada en fecha identifica este contrato. Dentro de una versión pueden agregarse campos retrocompatibles. Los cambios incompatibles requieren una nueva ruta base con versión y una transición documentada.

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