Batch send email (including templates)

Batch send email (text, html, text&html, templates). Please note that the endpoint will return a 200-level http status, even when sending for individual messages may fail. Users of this endpoint should check the success and errors for each message in the response (the results are ordered the same as the original messages - requests). Please note that the endpoint accepts up to 500 messages per API call, and up to 50 MB payload size, including attachments.

post

Authorizations

Api-TokenstringRequired

Pass the API token in the Api-Token

Path parameters

sandbox_idinteger · int64 · min: 1Required

Sandbox ID

Example: 4015

Body

Responses

200

Success. Check individual responses if messages have been delivered.

application/json

successbooleanOptional

Indicates whether the was a general error. When false, you should check the errors array for information. When true, you should check individual message responses and their success.

Example: true

errorsstring[]Optional

General request errors.

400

Bad request. Fix errors listed in response before retrying.

application/json

401

Unauthorized. Make sure you are sending correct credentials with the request before retrying.

application/json

500

Internal error. Messages were not delivered. Retry later or contact support.

application/json

post/api/batch/{sandbox_id}

curl -X POST https://sandbox.api.mailtrap.io/api/batch/{sandbox_id} \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "base": {"from": {"email": "[e-mail]"}, "subject": "Batch Email"},
    "requests": [{"to": [{"email": "[e-mail]"}]}, {"to": [{"email": "[e-mail]"}]}]
  }'

{
  "success": true,
  "responses": [
    {
      "success": true,
      "message_ids": [
        "0c7fd939-02cf-11ed-88c2-0a58a9feac02"
      ],
      "errors": [
        "text"
      ]
    }
  ],
  "errors": [
    "text"
  ]
}