Emails

Send multiple emails

Changed on

Send up to 100 emails in a single request. Useful for sending personalized emails to multiple recipients efficiently.

Each email in the batch can have different content and recipients. Failed emails don't affect other emails in the batch.

Idempotency: Supports Idempotency-Key header for safe retries.

post/emails/batch

Request

Headers

Idempotency-Keystring

Unique key for idempotent requests. If a request with this key was already processed, the cached response is returned. Keys expire after 24 hours.

Request body

fromstring required

Sender email for all messages

Example request

{
  "emails": [
    {
      "metadata": {
        "user_id": "usr_123456",
        "order_id": "ord_789012",
        "campaign": "welcome_series"
      }
    }
  ]
}

Response

Batch accepted

successtrue required

Example response

{
  "data": {
    "total": 10,
    "accepted": 9,
    "failed": 1
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Changes

    • warning

      the optional response header X-RateLimit-Limit removed for the status 429

    • warning

      the optional response header X-RateLimit-Remaining removed for the status 429

    • warning

      the optional response header X-RateLimit-Reset removed for the status 429

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • warning

      added the new infrastructure_error enum value to the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status

    • info

      removed the postal_error enum value from the / response property for the response status