Skip to main content
POST
Exportação em massa de entidades por e-mail

Visão geral

Exporta entidades com os mesmos filtros de GET /entities, gera um arquivo (csv, xlsx ou json) e entrega por e-mail. Resposta 202 com jobId; consulte GET /entities/export/jobs/{jobId}.

Endpoint

Autenticação, permissões e marketplace

Igual a Relatório PDF por e-mail: Authorization, X-Organization-ID, entities:export, global_sender_email, cobrança por destinatário.

Domínio e remetente

  • fromEmail: domínio verificado; remetente cadastrado não é obrigatório.
  • fromSenderId: UUID em organization_email_senders.
  • Não enviar os dois juntos.

Corpo JSON

string[]
required
Destinatários (máx. 26 deduplicados). Somente esses endereços.
string
required
csv, xlsx ou json.
object
Mesma forma dos filtros de GET /entities. Padrão {}.
string
en, es ou pt.
string[]
Colunas snake_case opcionais; omitir = todas permitidas.
string (uuid)
Remetente por UUID. Exclusivo com fromEmail.
string
Remetente em domínio verificado. Exclusivo com fromSenderId.

Exemplo

Resposta 202

Acompanhamento

  • GET /entities/export/jobs/{jobId} — status.
  • E-mail de conclusão pode incluir link assinado.

Erros 400

Mesmos códigos de report-export-email.

Relacionado