Skip to main content
Submit Email Batch
This endpoint accepts a batch for processing and returns a batch_id for correlation. Each email’s full analysis result is delivered asynchronously through the email.intelligence.completed webhook. See the Webhook Payload Reference for response fields and examples.

Authorizations

x-api-key
string
header
required

Body

application/json
emails
object[]
required

Array of Email Objects to analyze

batch_id
string

Append these emails to an existing batch instead of creating a new one. Pass the batch_id returned by an earlier call. The batch must belong to the same project and still be within 24 hours of its most recent request; each append extends that window. batch_name is ignored when appending. See Building a batch across requests.

batch_name
string

Optional name for the batch. If not provided, one is auto-generated.

identity_intelligence
boolean

Enable deeper identity analysis for all emails in the batch. See Identity Intelligence.

Response

Batch accepted for processing

batch_id
string

Unique identifier for this batch

batch_name
string

Name of the batch (provided or auto-generated)

status
string

pending on creation. When appending, the batch's current lifecycle status (pending or in_progress).

total_count
integer

Number of emails in the batch. When appending, the cumulative total after this call.

webhook_configured
boolean

Whether the project has an active webhook subscription for email intelligence results. If false, results are still processed but no webhook will be delivered.