Valori UTM da usare quando utm_tracking è attivo. Ogni chiave imposta un parametro utm_:

• source (predefinito emailit), medium (predefinito email) e campaign (predefinito {campaign_name}).
• content, term e id, non aggiunti per impostazione predefinita.

I valori sono testo fino a 191 caratteri e possono contenere i token {campaign_name} (il nome della campagna in minuscolo, con trattini), {campaign_id}, {subject}, {variant} (il nome della versione del test A/B) e {send_date} (YYYY-MM-DD). Chiavi e token sconosciuti restituiscono 422. Le chiavi che non imposti mantengono i valori predefiniti; null o {} li ripristina tutti.

Un test A/B con da 2 a 5 versioni. Una quota casuale dei destinatari viene divisa in parti uguali tra le versioni. Dopo duration_hours, il resto dei destinatari riceve la versione con il risultato migliore. Mentre il test è in corso, lo stato della campagna è testing. I test A/B vengono inviati con la strategia immediate, subito o a un orario programmato.

• enabled (boolean, predefinito true): false disattiva il test.
• winner_metric (string, predefinito opened): opened, clicked, orders (ordini attribuiti per email inviata) o revenue (ricavi attribuiti per email inviata). orders e revenue fanno parte dell’e-commerce, che è in alpha: le altre richieste restituiscono 403 con error: "commerce_alpha".
• test_size_percent (integer, predefinito 20): quota dei destinatari inclusa nel test, da 10 a 100. Con 100 tutti sono nel test e non viene inviata nessuna versione vincente.
• duration_hours (integer, predefinito 4): quanto dura il test prima dell’invio della versione vincente, da 1 a 168.
• variants (object[], obbligatorio): da 2 a 5 versioni. Ognuna può impostare name (fino a 100 caratteri, predefiniti A, B, C e così via), subject, preview_text, from_name, from_email, reply_to, html e text. I campi che una versione omette vengono presi dalla campagna. Almeno una versione deve impostare un oggetto, un testo di anteprima, un nome o un indirizzo del mittente oppure un corpo.

Cosa ha fatto l’ultimo invio, oppure null prima che la campagna venga inviata:

• recipients: contatti nelle liste e nei segmenti, una volta per indirizzo.
• suppressed: saltati perché l’indirizzo è soppresso.
• smart_sending_skipped: saltati da smart_sending_hours.
• unengaged_skipped: saltati da exclude_unengaged.
• sent: contatti a cui è stata inviata la campagna. Per un test A/B, solo il gruppo di test.
• batches: numero di batch di invio.
• completes_at: uguale a send_completes_at.

Il test A/B. Senza un test: { "enabled": false, "variants": [] }. Con un test: enabled, winner_metric, test_size_percent, duration_hours e variants. Ogni versione ha id (cvr_…), name, subject, preview_text, from_name, from_email, reply_to, html, text (null quando la versione usa il valore della campagna) e is_winner. Vedi Crea una campagna.

Il test A/B, con i campi descritti in Crea una campagna. Se invii ab_test, il test e le sue versioni vengono sostituiti. Per mantenere l’ID di una versione, e con esso i suoi risultati, includi il suo id (cvr_…) nella versione. null o "enabled": false disattiva il test ed elimina le versioni.

Le liste e i segmenti a cui destinare la campagna, fino a 100 elementi. Sostituisce l’elenco attuale. Includi almeno un elemento con exclude impostato su false. Ogni elemento ha audience_id oppure segment_id, non entrambi:

• audience_id (string): l’ID di una lista (aud_…) di questo workspace.
• segment_id (string): l’ID di un segmento (seg_…) di questo workspace. I segmenti sono in alpha: solo il team di Emailit può aggiungerne uno, e le altre richieste restituiscono 403 con error: "segments_alpha". I segmenti che la campagna ha già si possono mantenere.
• exclude (boolean, predefinito false): true esclude gli iscritti della lista o i contatti del segmento, anche se si trovano anche in un elemento incluso.

Gli elementi duplicati vengono ignorati. Al momento dell’invio, Emailit invia un’email una sola volta a ogni contatto che è iscritto a una lista inclusa o corrisponde a un segmento incluso, non si trova in un elemento escluso, non è disiscritto a livello globale, è iscritto ad almeno una lista e non è soppresso. I segmenti vengono valutati al momento dell’invio. Se a quel punto una lista o un segmento esclusi non esistono più, la campagna non viene inviata.

all (predefinito) richiede che corrispondano tutti i filtri. or richiede che ne corrisponda almeno uno. Vedi Filtri e ordinamento.

Chiave di ordinamento di questo elenco. Vedi le chiavi di ordinamento qui sotto.

asc o desc.

Quando inviare. Accetta ISO 8601 (2026-10-08T09:00:00Z), un timestamp Unix in secondi o un’espressione in linguaggio naturale come tomorrow at 9am (interpretata in UTC). L’orario deve essere nel futuro e la campagna deve essere draft.

Omettilo per inviare subito. Per inviare in anticipo una campagna programmata, chiama questo endpoint senza scheduled_at.

Come distribuire l’invio nel tempo. Il valore predefinito è la strategia salvata nella campagna, altrimenti immediate. La strategia e le sue opzioni vengono salvate nella campagna. Vedi Opzioni di invio.

• immediate: tutti insieme, subito o a scheduled_at.
• throttled: un ritmo costante di per_hour email, a partire da subito o da scheduled_at.
• local_time: un orario fisso nel fuso orario di ogni contatto. scheduled_at viene ignorato.
• smart_time: ogni contatto nell’ora in cui di solito apre o clicca, entro una finestra dall’inizio.

Le campagne con un test A/B vengono inviate solo con immediate.

Opzioni della strategia. Il valore predefinito sono le opzioni salvate nella campagna.

• throttled: per_hour (integer, obbligatorio), da 100 a 1.000.000 email all’ora.
• local_time: local_time (string, obbligatorio), l’orario nel formato YYYY-MM-DDTHH:mm, ad esempio 2026-10-08T09:00, e timezone (string, predefinito UTC), il fuso orario IANA per i contatti di cui non si conosce il fuso orario. I fusi orari dei contatti provengono dallo script di tracciamento. L’invio inizia quando l’orario arriva nel primo fuso orario (UTC+14); i contatti nei fusi in cui l’orario è già passato ricevono l’email subito. Fino ad allora la campagna è scheduled, quindi deve essere una bozza. Restituisce 422 quando l’orario è già passato in tutti i fusi orari.
• smart_time: window_hours (integer, predefinito 24), da 1 a 48. Ogni contatto riceve l’email nell’ora del giorno (UTC) in cui ha aperto o cliccato di più negli ultimi 90 giorni, con un clic che vale tre volte un’apertura, se quell’ora cade nella finestra. I contatti senza questo storico ricevono l’ora più frequente tra gli altri destinatari. I contatti senza nessuno dei due, o la cui ora cade fuori dalla finestra, la ricevono all’inizio.

timezone è accettato con ogni strategia e deve essere un fuso orario IANA valido, ma lo usa solo local_time.

L’ID della campagna (cmp_...) o il nome della campagna. Codifica nell’URL i nomi che contengono spazi o caratteri speciali.

Conta solo le email create a partire da questo momento, una data o una data e ora ISO 8601.

Conta solo le email create fino a questo momento compreso.

Conta solo le email il cui stato attuale è questo: accepted, scheduled, delivered, loaded, clicked, attempted, bounced, failed, rejected, suppressed o complained. Gli altri valori vengono ignorati.

Sempre campaign_stats.

L’ID della campagna (cmp_...).

Email create per la campagna. sent_percent è 100, oppure 0 prima che venga inviato qualcosa.

Email con stato delivered, loaded o clicked.

Email aperte almeno una volta.

Email con almeno un clic tracciato.

clicked come percentuale di opened.

Email con stato bounced, suppressed, complained o attempted (in attesa di un nuovo tentativo). Ognuno ha anche un campo _percent.

Email ancora accepted o scheduled.

Disiscrizioni dalle email della campagna.

Risultati per provider di posta dei destinatari, per i provider con almeno un’email. key è gmail, outlook.com, live.com, hotmail.com, yahoo, icloud o other, e label è il suo nome visualizzato. Ognuno ha sent, delivered, opened, clicked e bounced con i rispettivi campi _percent. sent_percent è la quota del provider su tutte le email; le altre percentuali sono relative al sent del provider.

Solo per il team di Emailit finché l’e-commerce è in alpha: le altre richieste non ricevono questo campo, e le loro variants A/B omettono orders, revenue e revenue_per_recipient. Ordini attribuiti alla campagna. I ricavi sono il totale dell’ordine meno i rimborsi, e gli ordini annullati non contano. Gli importi in valute diverse non vengono sommati: la valuta principale è quella con più ricavi.

• currency (string o null): la valuta principale.

• revenue (number): i ricavi nella valuta principale.

• orders (integer): gli ordini attribuiti in tutte le valute.

• buyers (integer): gli acquirenti distinti in tutte le valute. Un acquirente che ha pagato in due valute conta una sola volta.

• average_order_value (number): nella valuta principale.

• conversion_percent (number): buyers come percentuale delle email consegnate della campagna.

• revenue_per_recipient (number): revenue diviso per le email consegnate della campagna.

• by_currency (object[]): currency, orders, revenue, buyers e average_order_value per ogni valuta, a partire dai ricavi più alti.

Solo per le campagne con un test A/B.

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

• leader_variant_id (string o null): la versione con il tasso migliore finora: aperture, clic od ordini per email inviata, oppure ricavi per email inviata.

• win_probability (number o null): la probabilità, in percentuale, che la versione in testa batta davvero la seconda.

• significance (string): significant (90% o più, con almeno 50 email per versione), promising (75% o più, con lo stesso minimo), not_significant (meno del 75% con almeno 1800 email per versione) o inconclusive. Per revenue, la probabilità si basa sugli ordini.

• variants (object[]): per ogni versione variant_id, name, subject, is_winner, sent, delivered, opened, opened_percent, clicked, clicked_percent, orders, revenue e revenue_per_recipient. Quando la versione vincente viene inviata al resto della lista, i conteggi della versione vincente includono quelle email.