Skip to main content
POST
/
entities
/
export
/
jobs
Exportação em massa de entidades por e-mail
curl --request POST \
  --url http://api.gu1.ai/entities/export/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recipientEmails": [
    "<string>"
  ],
  "format": "<string>",
  "filters": {},
  "emailLocale": "<string>",
  "columns": [
    "<string>"
  ],
  "fromSenderId": {},
  "fromEmail": "<string>"
}
'

​
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

POST http://api.gu1.ai/entities/export/jobs

​
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

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

​
Exemplo

{
  "recipientEmails": ["analista@exemplo.com"],
  "format": "csv",
  "emailLocale": "pt",
  "fromEmail": "exportacoes@seu-dominio.com",
  "filters": {}
}

​
Resposta 202

{
  "jobId": "uuid-do-job",
  "message": "…"
}

​
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