Skip to content

Create an email batch

Request

Creates a new, empty email batch. Only a Description is required at creation; the body, recipients, attachments, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations.

Security
basicAuth
Bodyapplication/jsonrequired
Descriptionstring, <= 255 charactersrequired

Human-readable description of the batch.

curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v2/EviMail/Batches \
  -H 'Content-Type: application/json' \
  -d '{
    "Description": "March 2026 customer emails"
  }'

Responses

Batch created.

Bodyapplication/json
BatchIdstring, (uuid)

Unique identifier of the created batch. Use it in all other batch operations.

Response
{ "BatchId": "550e8400-e29b-41d4-a716-446655440000" }