v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Email Messages

Create a batch of email messages

Creates up to 50 email messages in a single request.

post/email_messages/batch

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

sandbox_modeboolean

Applies sandbox mode to all messages in the batch. Overrides any per-message sandbox_mode in the messages array.

Response

Multi-Status — all batch responses return 207. When all messages succeed, errors is empty and every item is in data. When one or more fail, the response contains a data array for successes and an errors array for failures.

Example response

{
  "data": [
    {
      "recipient_statuses": {
        "bounced": 2,
        "delivered": 998
      }
    }
  ]
}