Valores UTM a usar quando utm_tracking estiver ativado. Cada chave define um parâmetro utm_:

• source (padrão emailit), medium (padrão email) e campaign (padrão {campaign_name}).
• content, term e id, que não são adicionados por padrão.

Os valores são textos de até 191 caracteres e podem conter os tokens {campaign_name} (o nome da campanha em minúsculas, com hifens), {campaign_id}, {subject}, {variant} (o nome da versão do teste A/B) e {send_date} (YYYY-MM-DD). Chaves e tokens desconhecidos retornam 422. As chaves que você não define mantêm os valores padrão; null ou {} redefine todas elas.

Um teste A/B de 2 a 5 versões. Uma parte aleatória dos destinatários é dividida igualmente entre as versões. Depois de duration_hours, o resto dos destinatários recebe a versão com o melhor resultado. Enquanto o teste está em andamento, o status da campanha é testing. Os testes A/B são enviados com a estratégia immediate, agora ou em um horário agendado.

• enabled (booleano, padrão true): false desativa o teste.
• winner_metric (string, padrão opened): opened, clicked, orders (pedidos atribuídos por e-mail enviado) ou revenue (receita atribuída por e-mail enviado). orders e revenue fazem parte do e-commerce, que está em alfa: as outras requisições retornam 403 com error: "commerce_alpha".
• test_size_percent (inteiro, padrão 20): a parte dos destinatários no teste, de 10 a 100. Com 100, todos estão no teste e nenhuma vencedora é enviada.
• duration_hours (inteiro, padrão 4): quanto tempo o teste dura antes de a vencedora ser enviada, de 1 a 168.
• variants (object[], obrigatório): de 2 a 5 versões. Cada uma pode definir name (até 100 caracteres; o padrão é A, B, C e assim por diante), subject, preview_text, from_name, from_email, reply_to, html e text. Os campos que uma versão não define vêm da campanha. Pelo menos uma versão precisa definir um assunto, um texto de pré-visualização, um nome ou endereço de remetente ou um corpo.

O que o último envio fez, ou null antes de a campanha ser enviada:

• recipients: os contatos das listas de contatos e dos segmentos, uma vez por endereço.
• suppressed: ignorados porque o endereço está suprimido.
• smart_sending_skipped: ignorados por smart_sending_hours.
• unengaged_skipped: ignorados por exclude_unengaged.
• sent: os contatos para os quais a campanha foi enviada. Em um teste A/B, só o grupo de teste.
• batches: número de lotes de envio.
• completes_at: o mesmo que send_completes_at.

O teste A/B. Sem teste: { "enabled": false, "variants": [] }. Com teste: enabled, winner_metric, test_size_percent, duration_hours e variants. Cada versão tem id (cvr_…), name, subject, preview_text, from_name, from_email, reply_to, html, text (null quando a versão usa o valor da campanha) e is_winner. Consulte Criar uma campanha.

O teste A/B, com os campos descritos em Criar uma campanha. Enviar ab_test substitui o teste e as versões dele. Para manter o ID de uma versão, e com ele os resultados dela, inclua o id (cvr_…) na versão. null ou "enabled": false desativa o teste e exclui as versões.

As listas de contatos e os segmentos de destino, até 100 itens. Substitui a relação atual. Inclua pelo menos um item com exclude definido como false. Cada item tem audience_id ou segment_id, nunca os dois:

• audience_id (string): um ID de lista de contatos (aud_…) deste workspace.
• segment_id (string): um ID de segmento (seg_…) deste workspace. Os segmentos estão em alfa: apenas a equipe do Emailit pode adicionar um, e as outras requisições retornam 403 com error: "segments_alpha". Os segmentos que a campanha já tem podem ser mantidos.
• exclude (booleano, padrão false): true deixa de fora os inscritos da lista ou os contatos do segmento, mesmo que eles também estejam em um item incluído.

Itens duplicados são ignorados. No momento do envio, o Emailit envia um e-mail uma única vez a cada contato que está inscrito em uma lista incluída ou corresponde a um segmento incluído, não está em um item excluído, não está descadastrado globalmente, está inscrito em pelo menos uma lista e não está suprimido. Os segmentos são avaliados no momento do envio. Se uma lista ou um segmento excluído não existir mais nesse momento, a campanha não é enviada.

all (padrão) exige todos os filtros. or corresponde a qualquer filtro. Consulte Filtragem.

Chave de ordenação desta lista. Consulte as chaves de ordenação abaixo.

asc ou desc.

Quando enviar. Aceita ISO 8601 (2026-10-08T09:00:00Z), um timestamp Unix em segundos ou linguagem natural em inglês, como tomorrow at 9am (interpretada em UTC). O horário deve estar no futuro e a campanha deve ser um draft.

Omita-o para enviar agora. Para enviar antes uma campanha agendada, chame este endpoint sem scheduled_at.

Como distribuir o envio ao longo do tempo. O padrão é a estratégia salva na campanha ou, se não houver uma, immediate. A estratégia e as opções dela são salvas na campanha. Consulte Opções de envio.

• immediate: todos de uma vez, agora ou em scheduled_at.
• throttled: um ritmo uniforme de per_hour e-mails, começando agora ou em scheduled_at.
• local_time: um horário de relógio no fuso horário de cada contato. scheduled_at é ignorado.
• smart_time: cada contato no horário em que costuma abrir ou clicar, dentro de uma janela a partir do início.

As campanhas com um teste A/B só são enviadas com immediate.

Opções da estratégia. O padrão são as opções salvas na campanha.

• throttled: per_hour (inteiro, obrigatório), de 100 a 1.000.000 e-mails por hora.
• local_time: local_time (string, obrigatório), o horário no formato YYYY-MM-DDTHH:mm, por exemplo 2026-10-08T09:00, e timezone (string, padrão UTC), o fuso horário IANA para os contatos cujo fuso horário não é conhecido. Os fusos horários dos contatos vêm do script de rastreamento. O envio começa quando o primeiro fuso horário (UTC+14) chega ao horário; os contatos em fusos em que ele já passou recebem o e-mail na hora. Até lá, a campanha fica em scheduled, então ela precisa ser um rascunho. Retorna 422 quando o horário já passou em todos os fusos horários.
• smart_time: window_hours (inteiro, padrão 24), de 1 a 48. Cada contato recebe o e-mail na hora do dia (UTC) em que mais abriu ou clicou nos últimos 90 dias, com um clique valendo três vezes mais que uma abertura, quando essa hora cai dentro da janela. Os contatos sem esse histórico recebem na hora mais comum entre os outros destinatários. Os contatos sem nenhum dos dois, ou cuja hora fica fora da janela, recebem no início.

timezone é aceito em todas as estratégias e precisa ser um fuso horário IANA válido, mas só local_time o usa.

O ID da campanha (cmp_...) ou o nome da campanha. Codifique para URL os nomes que contêm espaços ou caracteres especiais.

Conta só os e-mails criados neste momento ou depois dele, uma data ou data e hora ISO 8601.

Conta só os e-mails criados neste momento ou antes dele.

Conta só os e-mails cujo status atual é este: accepted, scheduled, delivered, loaded, clicked, attempted, bounced, failed, rejected, suppressed ou complained. Os outros valores são ignorados.

Sempre campaign_stats.

O ID da campanha (cmp_...).

Os e-mails criados para a campanha. sent_percent é 100, ou 0 antes de qualquer envio.

Os e-mails cujo status é delivered, loaded ou clicked.

Os e-mails abertos pelo menos uma vez.

Os e-mails com pelo menos um clique rastreado.

clicked como porcentagem de opened.

Os e-mails cujo status é bounced, suppressed, complained ou attempted (aguardando uma nova tentativa). Cada um também tem um campo _percent.

Os e-mails ainda accepted ou scheduled.

Descadastros a partir dos e-mails da campanha.

Resultados por provedor de e-mail dos destinatários, para os provedores com pelo menos um e-mail. key é gmail, outlook.com, live.com, hotmail.com, yahoo, icloud ou other, e label é o nome de exibição dele. Cada um tem sent, delivered, opened, clicked e bounced com os campos _percent correspondentes. sent_percent é a participação do provedor em todos os e-mails; as outras porcentagens são relativas ao sent do provedor.

Apenas para a equipe do Emailit enquanto o e-commerce estiver em alfa: as outras requisições não recebem este campo, e as variants do teste A/B delas deixam de fora orders, revenue e revenue_per_recipient. Pedidos atribuídos à campanha. A receita é o total do pedido menos os reembolsos, e os pedidos cancelados não contam. Os valores em moedas diferentes não são somados: a moeda principal é a que tem mais receita.

• currency (string ou null): a moeda principal.

• revenue (número): a receita na moeda principal.

• orders (inteiro): os pedidos atribuídos em todas as moedas.

• buyers (inteiro): os compradores distintos em todas as moedas. Um comprador que pagou em duas moedas conta uma vez.

• average_order_value (número): na moeda principal.

• conversion_percent (número): buyers como porcentagem dos e-mails entregues da campanha.

• revenue_per_recipient (número): revenue dividido pelos e-mails entregues da campanha.

• by_currency (object[]): currency, orders, revenue, buyers e average_order_value de cada moeda, da maior receita para a menor.

Só para campanhas com um teste A/B.

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

• leader_variant_id (string ou null): a versão com a melhor taxa até agora: aberturas, cliques ou pedidos por e-mail enviado, ou receita por e-mail enviado.

• win_probability (número ou null): a probabilidade, em porcentagem, de que a versão na liderança realmente supere a segunda colocada.

• significance (string): significant (90% ou mais, com pelo menos 50 e-mails por versão), promising (75% ou mais, com o mesmo mínimo), not_significant (menos de 75% com pelo menos 1.800 e-mails por versão) ou inconclusive. Para revenue, a probabilidade se baseia nos pedidos.

• variants (object[]): por versão, variant_id, name, subject, is_winner, sent, delivered, opened, opened_percent, clicked, clicked_percent, orders, revenue e revenue_per_recipient. Depois que a vencedora é enviada para o resto do público, as contagens da versão vencedora incluem esses e-mails.