Referencia
Todos los endpoints
Todos los endpoints de la API v2 de Emailit en un solo lugar, agrupados por recurso, con su método HTTP, su ruta, el permiso de clave de API que necesitan y un enlace a su referencia.
Esta página enumera todos los endpoints de la API de Emailit, agrupados por recurso. Las rutas son relativas a la URL base https://api.emailit.com/v2, y {id} representa el ID del objeto (o, si el endpoint lo permite, su nombre o su dirección de email).
La columna Permiso indica qué claves de API pueden llamar al endpoint:
| Permiso | Funciona con |
|---|---|
sending |
Claves con el permiso sending o full. |
events |
Claves con el permiso events o full. |
full |
Solo claves con el permiso full. |
Los tokens de acceso OAuth siguen las mismas reglas que las claves de API con el mismo permiso. OAuth no tiene un permiso events, así que los tokens necesitan full para esos endpoints.
Emails
Envía emails, consulta los mensajes y su contenido, y prográmalos, cancélalos, reinténtalos o reenvíalos. Para la referencia completa, consulta Emails.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Enviar un email | POST |
/emails |
sending |
| Listar emails | GET |
/emails |
full |
| Obtener un email | GET |
/emails/{id} |
full |
| Obtener el MIME en bruto | GET |
/emails/{id}/raw |
full |
| Listar adjuntos | GET |
/emails/{id}/attachments |
full |
| Obtener el cuerpo | GET |
/emails/{id}/body |
full |
| Obtener los metadatos | GET |
/emails/{id}/meta |
full |
| Actualizar un email programado | POST |
/emails/{id} |
sending |
| Cancelar un email | POST |
/emails/{id}/cancel |
sending |
| Reintentar un email | POST |
/emails/{id}/retry |
sending |
| Reenviar un email | POST |
/emails/{id}/forward |
sending |
| Obtener solo el estado | GET |
/email/{id} |
full |
Dominios
Añade dominios de envío, consulta sus registros DNS y su estado de verificación, y verifícalos. Para la referencia completa, consulta Dominios.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un dominio | POST |
/domains |
full |
| Obtener un dominio | GET |
/domains/{id} |
full |
| Verificar un dominio | POST |
/domains/{id}/verify |
full |
| Actualizar un dominio | POST |
/domains/{id} |
full |
| Listar dominios | GET |
/domains |
full |
| Eliminar un dominio | DELETE |
/domains/{id} |
full |
Informes DMARC
Consulta los informes DMARC agregados y forenses de un dominio de envío, o sube los tuyos. Para la referencia completa, consulta Informes DMARC.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Listar informes agregados | GET |
/domains/{id}/dmarc/reports |
full |
| Obtener un informe | GET |
/domains/{id}/dmarc/reports/{report_id} |
full |
| Subir un informe | POST |
/domains/{id}/dmarc/reports |
full |
| Listar informes forenses | GET |
/domains/{id}/dmarc/forensic |
full |
| Obtener un informe forense | GET |
/domains/{id}/dmarc/forensic/{report_id} |
full |
| Obtener estadísticas | GET |
/domains/{id}/dmarc/stats |
full |
| Listar orígenes de envío | GET |
/domains/{id}/dmarc/sources |
full |
| Listar países | GET |
/domains/{id}/dmarc/countries |
full |
| Listar redes (ASN) | GET |
/domains/{id}/dmarc/asns |
full |
| Listar emisores de informes | GET |
/domains/{id}/dmarc/reporters |
full |
Claves de API
Crea, lista, renombra y revoca las claves de API de un espacio de trabajo. Para la referencia completa, consulta Claves de API.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una clave de API | POST |
/api-keys |
full |
| Obtener una clave de API | GET |
/api-keys/{id} |
full |
| Listar claves de API | GET |
/api-keys |
full |
| Actualizar una clave de API | POST |
/api-keys/{id} |
full |
| Regenerar una clave de API | POST |
/api-keys/{id}/regenerate |
full |
| Eliminar una clave de API | DELETE |
/api-keys/{id} |
full |
Listas de contactos
Gestiona las listas de suscriptores que usan las campañas y los formularios de suscripción. Para la referencia completa, consulta Listas de contactos.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una lista de contactos | POST |
/audiences |
full |
| Obtener una lista de contactos | GET |
/audiences/{id} |
full |
| Actualizar una lista de contactos | POST |
/audiences/{id} |
full |
| Listar listas de contactos | GET |
/audiences |
full |
| Eliminar una lista de contactos | DELETE |
/audiences/{id} |
full |
Suscriptores
Añade, actualiza y quita los suscriptores de una lista de contactos. Para la referencia completa, consulta Suscriptores.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Añadir un suscriptor | POST |
/audiences/{audience_id}/subscribers |
full |
| Obtener un suscriptor | GET |
/audiences/{audience_id}/subscribers/{id} |
full |
| Actualizar un suscriptor | POST |
/audiences/{audience_id}/subscribers/{id} |
full |
| Listar suscriptores | GET |
/audiences/{audience_id}/subscribers |
full |
| Eliminar un suscriptor | DELETE |
/audiences/{audience_id}/subscribers/{id} |
full |
Contactos
Gestiona los perfiles de contacto y los campos personalizados, de forma masiva o de uno en uno. Para la referencia completa, consulta Contactos.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un contacto | POST |
/contacts |
full |
| Obtener un contacto | GET |
/contacts/{id} |
full |
| Actualizar un contacto | POST |
/contacts/{id} |
full |
| Listar contactos | GET |
/contacts |
full |
| Actualizar contactos de forma masiva | POST |
/contacts/bulk |
full |
| Exportar contactos | GET, POST |
/contacts/export |
full |
| Eliminar un contacto | DELETE |
/contacts/{id} |
full |
Segmentos
Guarda filtros sobre tus contactos, lista quién coincide con ellos y sigue la evolución de los segmentos con seguimiento. Para la referencia completa, consulta Segmentos.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un segmento | POST |
/segments |
full |
| Obtener un segmento | GET |
/segments/{id} |
full |
| Actualizar un segmento | POST |
/segments/{id} |
full |
| Listar segmentos | GET |
/segments |
full |
| Eliminar un segmento | DELETE |
/segments/{id} |
full |
| Listar los contactos de un segmento | GET |
/segments/{id}/contacts |
full |
| Obtener el crecimiento de un segmento | GET |
/segments/{id}/growth |
full |
| Previsualizar un segmento | POST |
/segments/preview |
full |
| Listar los campos de segmento | GET |
/segments/fields |
full |
Campañas
Crea campañas, elige sus listas de contactos y segmentos, y envíalas o prográmalas. Para la referencia completa, consulta Campañas.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una campaña | POST |
/campaigns |
full |
| Obtener una campaña | GET |
/campaigns/{id} |
full |
| Actualizar una campaña | POST |
/campaigns/{id} |
full |
| Listar campañas | GET |
/campaigns |
full |
| Enviar o programar una campaña | POST |
/campaigns/{id}/send |
full |
| Cancelar una campaña | POST |
/campaigns/{id}/cancel |
full |
| Obtener las estadísticas de una campaña | GET |
/campaigns/{id}/stats |
full |
| Eliminar una campaña | DELETE |
/campaigns/{id} |
full |
Productos
Mantén el catálogo de tu tienda en Emailit para las cuadrículas de productos, las recomendaciones y los artículos de los pedidos. Para la referencia completa, consulta Productos. Está en beta en los planes Pro, Business y Contract. Consulta Quién puede usar Comercio electrónico.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear o actualizar un producto | POST |
/products |
events |
| Obtener un producto | GET |
/products/{id} |
full |
| Actualizar un producto | POST |
/products/{id} |
events |
| Listar productos | GET |
/products |
full |
| Crear o actualizar productos en bloque | POST |
/products/batch |
events |
| Listar las categorías de productos | GET |
/products/categories |
full |
| Eliminar un producto | DELETE |
/products/{id} |
full |
Pedidos
Envía los pedidos de tu tienda para atribuir los ingresos a los emails y crear perfiles de compras. Para la referencia completa, consulta Pedidos. Está en beta en los planes Pro, Business y Contract. Consulta Quién puede usar Comercio electrónico.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear o actualizar un pedido | POST |
/orders |
events |
| Obtener un pedido | GET |
/orders/{id} |
full |
| Actualizar un pedido | POST |
/orders/{id} |
events |
| Listar pedidos | GET |
/orders |
full |
| Importar pedidos en bloque | POST |
/orders/batch |
events |
| Eliminar un pedido | DELETE |
/orders/{id} |
full |
Carritos
Envía los carritos de tus compradores para que Emailit detecte los carritos abandonados. Para la referencia completa, consulta Carritos. Está en beta en los planes Pro, Business y Contract. Consulta Quién puede usar Comercio electrónico.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear o actualizar un carrito | POST |
/carts |
events |
| Obtener un carrito | GET |
/carts/{id} |
full |
| Listar carritos | GET |
/carts |
full |
| Eliminar un carrito | DELETE |
/carts/{id} |
full |
Cupones
Crea cupones y gestiona sus pools de códigos únicos para tus emails. Para la referencia completa, consulta Cupones. Está en beta en los planes Pro, Business y Contract. Consulta Quién puede usar Comercio electrónico.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un cupón | POST |
/coupons |
full |
| Obtener un cupón | GET |
/coupons/{id} |
full |
| Actualizar un cupón | POST |
/coupons/{id} |
full |
| Listar cupones | GET |
/coupons |
full |
| Eliminar un cupón | DELETE |
/coupons/{id} |
full |
| Listar los códigos de un cupón | GET |
/coupons/{id}/codes |
full |
| Añadir códigos a un cupón | POST |
/coupons/{id}/codes |
full |
Comercio electrónico
La configuración de Comercio electrónico, el resumen de ingresos y el perfil de compras de un contacto. Para la referencia completa, consulta Comercio electrónico. Está en beta en los planes Pro, Business y Contract. Consulta Quién puede usar Comercio electrónico.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Obtener la configuración de Comercio electrónico | GET |
/commerce/settings |
full |
| Actualizar la configuración de Comercio electrónico | POST |
/commerce/settings |
full |
| Obtener el resumen de Comercio electrónico | GET |
/commerce/overview |
full |
| Obtener el perfil de compras de un contacto | GET |
/contacts/{id}/commerce |
full |
Automatizaciones
Crea flujos de trabajo a partir de disparadores y pasos, lánzalos y consulta sus ejecuciones. Para la referencia completa, consulta Automatizaciones.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una automatización | POST |
/automations |
full |
| Obtener una automatización | GET |
/automations/{id} |
full |
| Actualizar una automatización | POST |
/automations/{id} |
full |
| Listar automatizaciones | GET |
/automations |
full |
| Eliminar una automatización | DELETE |
/automations/{id} |
full |
| Iniciar una automatización | POST |
/automations/{id}/start |
full |
| Pausar una automatización | POST |
/automations/{id}/pause |
full |
| Detener una automatización | POST |
/automations/{id}/stop |
full |
| Lanzar una ejecución | POST |
/automations/{id}/trigger |
full |
| Listar ejecuciones | GET |
/automations/{id}/runs |
full |
| Obtener una ejecución | GET |
/automations/{id}/runs/{run_id} |
full |
| Obtener estadísticas | GET |
/automations/{id}/stats |
full |
| Obtener estadísticas de un paso | GET |
/automations/{id}/steps/{step_key}/stats |
full |
Formularios
Crea formularios de suscripción, publícalos y rota su token público. Para la referencia completa, consulta Formularios.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un formulario | POST |
/forms |
full |
| Obtener un formulario | GET |
/forms/{id} |
full |
| Actualizar un formulario | POST |
/forms/{id} |
full |
| Listar formularios | GET |
/forms |
full |
| Publicar un formulario | POST |
/forms/{id}/publish |
full |
| Despublicar un formulario | POST |
/forms/{id}/unpublish |
full |
| Restablecer el token público | POST |
/forms/{id}/reset-token |
full |
| Eliminar un formulario | DELETE |
/forms/{id} |
full |
Plantillas
Crea versiones de plantillas, publica una por alias y úsalas al enviar. Para la referencia completa, consulta Plantillas.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una plantilla | POST |
/templates |
full |
| Obtener una plantilla | GET |
/templates/{id} |
full |
| Actualizar una plantilla | POST |
/templates/{id} |
full |
| Listar plantillas | GET |
/templates |
full |
| Publicar una plantilla | POST |
/templates/{id}/publish |
full |
| Eliminar una plantilla | DELETE |
/templates/{id} |
full |
Direcciones bloqueadas
Consulta y gestiona las direcciones a las que Emailit no enviará emails. Para la referencia completa, consulta Direcciones bloqueadas.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una dirección bloqueada | POST |
/suppressions |
full |
| Obtener una dirección bloqueada | GET |
/suppressions/{id} |
full |
| Actualizar una dirección bloqueada | POST |
/suppressions/{id} |
full |
| Listar direcciones bloqueadas | GET |
/suppressions |
full |
| Eliminar una dirección bloqueada | DELETE |
/suppressions/{id} |
full |
Webhooks
Registra endpoints que reciben notificaciones de eventos firmadas. Para la referencia completa, consulta Webhooks.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un webhook | POST |
/webhooks |
full |
| Obtener un webhook | GET |
/webhooks/{id} |
full |
| Actualizar un webhook | POST |
/webhooks/{id} |
full |
| Listar webhooks | GET |
/webhooks |
full |
| Eliminar un webhook | DELETE |
/webhooks/{id} |
full |
| Enviar un evento de prueba | POST |
/webhooks/{id}/test |
full |
| Rotar el secreto de firma | POST |
/webhooks/{id}/reset-secret |
full |
| Reintentar las peticiones fallidas | POST |
/webhooks/{id}/retry-failed |
full |
| Reintentar una petición | POST |
/webhooks/{id}/requests/{request_id}/retry |
full |
Eventos
Envía eventos de espacio de trabajo y personalizados, y consulta el flujo de eventos que hay detrás de los webhooks: entregas, rebotes, aperturas y más. Para la referencia completa, consulta Eventos.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Enviar un evento | POST |
/events |
events |
| Enviar eventos por lotes | POST |
/events/batch |
events |
| Listar eventos | GET |
/events |
full |
| Obtener un evento | GET |
/events/{id} |
full |
Eventos de espacio de trabajo
Define eventos de espacio de trabajo y los tipos de sus propiedades. Para la referencia completa, consulta Eventos de espacio de trabajo.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear un evento de espacio de trabajo | POST |
/workspace/events |
full |
| Obtener un evento de espacio de trabajo | GET |
/workspace/events/{id} |
full |
| Actualizar un evento de espacio de trabajo | POST |
/workspace/events/{id} |
full |
| Listar eventos de espacio de trabajo | GET |
/workspace/events |
full |
| Eliminar un evento de espacio de trabajo | DELETE |
/workspace/events/{id} |
full |
Claves de seguimiento
Gestiona las claves públicas del script de seguimiento. Para la referencia completa, consulta Claves de seguimiento.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una clave de seguimiento | POST |
/tracking-keys |
full |
| Obtener una clave de seguimiento | GET |
/tracking-keys/{id} |
full |
| Actualizar una clave de seguimiento | POST |
/tracking-keys/{id} |
full |
| Listar claves de seguimiento | GET |
/tracking-keys |
full |
| Eliminar una clave de seguimiento | DELETE |
/tracking-keys/{id} |
full |
Verificación de emails
Verifica una dirección en tiempo real. Para la referencia completa, consulta Verificación de emails.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Verificar una dirección | POST |
/email-verifications |
full |
Listas de direcciones
Verifica hasta 10.000 direcciones de una vez y exporta los resultados. Para la referencia completa, consulta Listas de direcciones.
| Endpoint | Método | Ruta | Permiso |
|---|---|---|---|
| Crear una lista | POST |
/email-verification-lists |
full |
| Listar listas | GET |
/email-verification-lists |
full |
| Obtener una lista | GET |
/email-verification-lists/{id} |
full |
| Listar resultados | GET |
/email-verification-lists/{id}/results |
full |
| Exportar resultados | GET |
/email-verification-lists/{id}/export |
full |