v1

latestOpenAPI 3.0.0MIT2026-08-0414772502.0 KB
E-mails em Lote

Envio em Lote (arquivo CSV/XLSX)

Cria um lote a partir de um arquivo CSV / TXT / XLS / XLSX enviado como multipart/form-data. Cada coluna do arquivo e associada a um campo pelo mapping (indice da coluna, base 0).

Autenticacao: token de usuario.

Campos do formulario:

  • datafile (file) - o arquivo. Ate 40MB / 140000 itens.
  • batch_name (text) - obrigatorio.
  • template_id (text) - obrigatorio (template ativo).
  • mapping (text, JSON) - mapeia campo -> indice da coluna. Deve conter no minimo destinatario e assunto, alem de todas as variaveis do template. Ex.: {"destinatario": 0, "assunto": 1, "nome": 2, "responder": 3, "assinar": 4}
  • has_header (text) - 1/true se a primeira linha for cabecalho (default: true).
  • delimiter (text) - separador de colunas do CSV (default: ,).

Alternativa JSON (base64): os mesmos dados podem ser enviados como JSON com o arquivo em base64 no campo batch_file, mais filename, mapping, header, delimiter, batch_name e template_id.

As colunas responder e assinar sao opcionais e tem o mesmo significado do modo JSON.

post/api/v2/batches

Response

Accepted

object required