v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

EMAILS

Send a batch of emails

post/email/batch

Request body

Example request

{
  "emails": [
    {
      "to": [
        "Jane Jones <jane@example.com>"
      ],
      "sender": "John Smith <john@example.com>",
      "subject": "My Test Email #1",
      "html_body": "<h1>Test <img src=\"cid:mypicture.jpg\" /></h1>",
      "text_body": "Test",
      "attachments": [
        {
          "filename": "report.pdf",
          "mimetype": "application/pdf",
          "fileblob": "bm90IGFjdHVhbGx5IGEgcGRm..."
        }
      ],
      "inlines": [
        {
          "filename": "mypicture.jpg",
          "mimetype": "image/jpeg",
          "url": "https://myserver.com/mypicture.jpg"
        }
      ]
    },
    {
      "to": [
        "Jane Jones <jane@example.com>"
      ],
      "sender": "John Smith <john@example.com>",
      "subject": "My Test Email #2",
      "html_body": "<h1>Test <img src=\"cid:mypicture.jpg\" /></h1>",
      "text_body": "Test",
      "attachments": [
        {
          "filename": "report.pdf",
          "mimetype": "application/pdf",
          "fileblob": "bm90IGFjdHVhbGx5IGEgcGRm..."
        }
      ],
      "inlines": [
        {
          "filename": "mypicture.jpg",
          "mimetype": "image/jpeg",
          "url": "https://myserver.com/mypicture.jpg"
        }
      ],
      "schedule": "2026-01-01 12:00:00 +1300"
    }
  ]
}

Response

An array of email_id/schedule_id values coinciding with the same order as the request payload.

request_idstring

Example response

{
  "request_id": "aa253464-0bd0-467a-b24b-6159dcd7be60",
  "data": [
    {
      "email_id": "123456-1234-12"
    },
    {
      "schedule_id": "188262b6-f6cc-4c98-bbe6-84c39d1c0ef4"
    },
    {
      "schedule_id": "789db207-5aba-4895-801b-4ebf1843721e"
    }
  ]
}