Skip to main content
POST
Exportación masiva de entidades por correo

Resumen

Exporta entidades según los mismos filtros que GET /entities, genera un archivo (csv, xlsx o json) y lo entrega por correo. La respuesta es 202 con jobId; consultá el estado con GET /entities/export/jobs/{jobId}.

Endpoint

Autenticación, permisos y marketplace

Igual que Informe PDF por correo: Authorization, X-Organization-ID, permiso entities:export, integración global_sender_email activa, cobro por destinatario en recipientEmails.

Dominio y remitente

Misma semántica que el PDF por correo:
  • fromEmail: dominio verificado en la org; no hace falta fila en Remitentes.
  • fromSenderId: UUID en organization_email_senders.
  • No enviar ambos a la vez.

Cuerpo JSON

string[]
required
Destinatarios del correo (máx. 26 deduplicados). Solo estas direcciones; no se fusiona el email del usuario de la API.
string
required
csv, xlsx o json.
object
Filtros con la misma forma que el query de GET /entities (búsqueda, fechas, tipo, etc.). Por defecto {}.
string
en, es o pt para el correo de finalización.
string[]
Columnas snake_case del layout de exportación; omitir o [] = todas las columnas permitidas.
string (uuid)
Remitente por UUID. Excluyente con fromEmail.
string
Remitente por dirección en dominio verificado. Excluyente con fromSenderId.

Ejemplo

Respuesta 202

Seguimiento del job

  • GET /entities/export/jobs/{jobId} — estado (queued, running, completed, failed).
  • GET /entities/export/jobs/{jobId}/download — metadatos de descarga cuando aplica.
  • El correo puede incluir enlace firmado al archivo (según configuración S3 del servidor).

Errores 400

Mismos códigos de pre-flight que report-export-email (NO_RECIPIENTS, DOMAIN_NOT_VERIFIED, INSUFFICIENT_BALANCE, etc.).

Relacionado