Los valores UTM que se usan cuando utm_tracking está activado. Cada clave define un parámetro utm_:

• source (por defecto, emailit), medium (por defecto, email) y campaign (por defecto, {campaign_name}).
• content, term e id, que no se añaden por defecto.

Los valores son texto de hasta 191 caracteres y pueden contener los tokens {campaign_name} (el nombre de la campaña en minúsculas, con guiones), {campaign_id}, {subject}, {variant} (el nombre de la versión de la prueba A/B) y {send_date} (YYYY-MM-DD). Las claves y los tokens desconocidos devuelven 422. Las claves que no defines conservan sus valores por defecto; null o {} los restablece todos.

Una prueba A/B de 2 a 5 versiones. Una parte aleatoria de los destinatarios se reparte a partes iguales entre las versiones. Pasadas duration_hours, el resto de los destinatarios recibe la versión con el mejor resultado. Mientras dura la prueba, el estado de la campaña es testing. Las pruebas A/B se envían con la estrategia immediate, en el momento o a una hora programada.

• enabled (booleano, por defecto true): false desactiva la prueba.
• winner_metric (cadena, por defecto opened): opened, clicked, orders (pedidos atribuidos por email enviado) o revenue (ingresos atribuidos por email enviado). orders y revenue forman parte de Comercio electrónico, que está en alfa: las demás peticiones devuelven 403 con error: "commerce_alpha".
• test_size_percent (entero, por defecto 20): la proporción de destinatarios que entra en la prueba, de 10 a 100. Con 100, todos entran en la prueba y no se envía ninguna ganadora.
• duration_hours (entero, por defecto 4): cuánto dura la prueba antes de enviar la ganadora, de 1 a 168.
• variants (array de objetos, obligatorio): de 2 a 5 versiones. Cada una puede definir name (hasta 100 caracteres; por defecto, A, B, C, etc.), subject, preview_text, from_name, from_email, reply_to, html y text. Los campos que una versión no define se toman de la campaña. Al menos una versión debe definir un asunto, un texto de vista previa, un nombre o una dirección de remitente, o un cuerpo.

Lo que hizo el último envío, o null antes de que se envíe la campaña:

• recipients: los contactos de las listas de contactos y los segmentos, una vez por dirección.
• suppressed: los omitidos porque la dirección está bloqueada.
• smart_sending_skipped: los omitidos por smart_sending_hours.
• unengaged_skipped: los omitidos por exclude_unengaged.
• sent: los contactos a los que se envió la campaña. En una prueba A/B, solo el grupo de prueba.
• batches: el número de lotes de envío.
• completes_at: igual que send_completes_at.

La prueba A/B. Sin prueba: { "enabled": false, "variants": [] }. Con prueba: enabled, winner_metric, test_size_percent, duration_hours y variants. Cada versión tiene id (cvr_…), name, subject, preview_text, from_name, from_email, reply_to, html, text (null si la versión usa el valor de la campaña) e is_winner. Consulta Crear una campaña.

La prueba A/B, con los campos que se describen en Crear una campaña. Si envías ab_test, se sustituyen la prueba y sus versiones. Para conservar el ID de una versión, y con él sus resultados, incluye su id (cvr_…) en la versión. null o "enabled": false desactiva la prueba y elimina las versiones.

Las listas de contactos y los segmentos a los que se dirige, hasta 100 elementos. Sustituye la lista actual. Incluye al menos un elemento con exclude en false. Cada elemento tiene audience_id o segment_id, no ambos:

• audience_id (cadena): el ID de una lista de contactos (aud_…) de este espacio de trabajo.
• segment_id (cadena): el ID de un segmento (seg_…) de este espacio de trabajo. Los segmentos están en alfa: solo el equipo de Emailit puede añadir uno, y las demás peticiones devuelven 403 con error: "segments_alpha". Los segmentos que la campaña ya tiene se pueden mantener.
• exclude (booleano, por defecto false): true deja fuera a los suscriptores de la lista o a los contactos del segmento, aunque también estén en un elemento incluido.

Los elementos duplicados se ignoran. Al enviar, Emailit envía un email una sola vez a cada contacto que está suscrito a una lista incluida o coincide con un segmento incluido, no está en uno excluido, no se ha dado de baja de forma global, está suscrito al menos a una lista y no tiene la dirección bloqueada. Los segmentos se evalúan en el momento del envío. Si para entonces ya no existe una lista o un segmento excluidos, la campaña no se envía.

all (por defecto) exige que se cumplan todos los filtros. or coincide con cualquier filtro. Consulta Filtrado.

Clave de ordenación de esta lista. Consulta las claves de ordenación más abajo.

asc o desc.

Cuándo enviarla. Acepta ISO 8601 (2026-10-08T09:00:00Z), una marca de tiempo Unix en segundos o lenguaje natural como tomorrow at 9am (interpretado en UTC). La hora debe ser futura y la campaña debe estar en draft.

Omítelo para enviarla ahora. Para enviar antes de tiempo una campaña programada, llama a este endpoint sin scheduled_at.

Cómo se reparte el envío en el tiempo. Por defecto, la estrategia guardada en la campaña o, si no hay ninguna, immediate. La estrategia y sus opciones se guardan en la campaña. Consulta Opciones de envío.

• immediate: todos a la vez, ahora o en scheduled_at.
• throttled: a un ritmo uniforme de per_hour emails, empezando ahora o en scheduled_at.
• local_time: una hora del reloj en la zona horaria de cada contacto. scheduled_at se ignora.
• smart_time: cada contacto a la hora a la que suele abrir o hacer clic, dentro de una ventana desde el inicio.

Las campañas con una prueba A/B solo se envían con immediate.

Las opciones de la estrategia. Por defecto, las opciones guardadas en la campaña.

• throttled: per_hour (entero, obligatorio), de 100 a 1.000.000 emails por hora.
• local_time: local_time (cadena, obligatorio), la hora en formato YYYY-MM-DDTHH:mm, por ejemplo 2026-10-08T09:00, y timezone (cadena, por defecto UTC), la zona horaria IANA de los contactos cuya zona horaria no se conoce. Las zonas horarias de los contactos proceden del script de seguimiento. El envío empieza cuando la zona horaria más temprana (UTC+14) llega a esa hora; los contactos de las zonas en las que ya ha pasado reciben el email al momento. Hasta entonces, la campaña está en scheduled, así que debe ser un borrador. Devuelve 422 si la hora ya ha pasado en todas las zonas horarias.
• smart_time: window_hours (entero, por defecto 24), de 1 a 48. Cada contacto recibe el email a la hora del día (UTC) a la que más abrió o hizo clic en los últimos 90 días, con un clic contando el triple que una apertura, cuando esa hora cae dentro de la ventana. Los contactos sin ese historial lo reciben a la hora más habitual entre los demás destinatarios. Los contactos que no tienen ninguna de las dos, o cuya hora cae fuera de la ventana, lo reciben al inicio.

timezone se acepta con todas las estrategias y debe ser una zona horaria IANA válida, pero solo la usa local_time.

El ID de la campaña (cmp_...) o el nombre de la campaña. Codifica para URL los nombres que contengan espacios o caracteres especiales.

Solo cuenta los emails creados en este momento o después, una fecha o una fecha y hora en formato ISO 8601.

Solo cuenta los emails creados en este momento o antes.

Solo cuenta los emails cuyo estado actual es este: accepted, scheduled, delivered, loaded, clicked, attempted, bounced, failed, rejected, suppressed o complained. Los demás valores se ignoran.

Siempre campaign_stats.

El ID de la campaña (cmp_...).

Los emails creados para la campaña. sent_percent es 100, o 0 antes de que se envíe nada.

Los emails cuyo estado es delivered, loaded o clicked.

Los emails abiertos al menos una vez.

Los emails con al menos un clic registrado.

clicked como porcentaje de opened.

Los emails cuyo estado es bounced, suppressed, complained o attempted (a la espera de un reintento). Cada uno tiene también un campo _percent.

Los emails que siguen en accepted o scheduled.

Las bajas procedentes de los emails de la campaña.

Los resultados por proveedor de correo de los destinatarios, para los proveedores con al menos un email. key es gmail, outlook.com, live.com, hotmail.com, yahoo, icloud u other, y label es su nombre visible. Cada uno tiene sent, delivered, opened, clicked y bounced con sus campos _percent. sent_percent es la proporción de todos los emails que corresponde al proveedor; los demás porcentajes son relativos al sent del proveedor.

Solo para el equipo de Emailit mientras Comercio electrónico está en alfa: las demás peticiones no reciben este campo, y las variants de sus pruebas A/B no incluyen orders, revenue ni revenue_per_recipient. Los pedidos atribuidos a la campaña. Los ingresos son el total del pedido menos los reembolsos, y los pedidos cancelados no cuentan. Los importes en monedas distintas no se suman: la moneda principal es la que tiene más ingresos.

• currency (cadena o null): la moneda principal.

• revenue (número): los ingresos en la moneda principal.

• orders (entero): los pedidos atribuidos en todas las monedas.

• buyers (entero): los compradores distintos en todas las monedas. Un comprador que pagó en dos monedas cuenta una sola vez.

• average_order_value (número): en la moneda principal.

• conversion_percent (número): buyers como porcentaje de los emails entregados de la campaña.

• revenue_per_recipient (número): revenue dividido entre los emails entregados de la campaña.

• by_currency (array de objetos): currency, orders, revenue, buyers y average_order_value de cada moneda, de más a menos ingresos.

Solo en las campañas con una prueba A/B.

• winner_metric (cadena): opened, clicked, orders o revenue.

• leader_variant_id (cadena o null): la versión con la mejor tasa hasta el momento: aperturas, clics o pedidos por email enviado, o ingresos por email enviado.

• win_probability (número o null): la probabilidad, en porcentaje, de que la versión que va en cabeza supere de verdad a la segunda.

• significance (cadena): significant (90 % o más, con al menos 50 emails por versión), promising (75 % o más, con el mismo mínimo), not_significant (menos del 75 % con al menos 1800 emails por versión) o inconclusive. En revenue, la probabilidad se basa en los pedidos.

• variants (array de objetos): por cada versión, variant_id, name, subject, is_winner, sent, delivered, opened, opened_percent, clicked, clicked_percent, orders, revenue y revenue_per_recipient. Una vez que la ganadora se envía al resto de la lista de contactos, los recuentos de la versión ganadora incluyen esos emails.