Skip to main content
POST
/
bulk_messages
Send multiple email messages (batch)
curl --request POST \
  --url https://api.paubox.net/v1/{api_username}/bulk_messages \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "messages": [
      {
        "recipients": [
          "recipient@host.com",
          "Recipient Name <recipient@host.com>"
        ],
        "bcc": [
          "recipient3@host.com",
          "Recipient Name <recipient4@host.com>"
        ],
        "headers": {
          "subject": "sample email",
          "from": "sender@authorized_domain.com",
          "reply-to": "Sender Name <sender@authorized_domain.com>",
          "x-custom-header": "sample custom header"
        },
        "content": {
          "text/plain": "Hello World!",
          "text/html": "<html><body><h1>Hello World!</h1></body></html>"
        },
        "attachments": [
          {
            "fileName": "hello_world.txt",
            "contentType": "text/plain",
            "content": "SGVsbG8gV29ybGQh"
          }
        ],
        "allowNonTLS": false,
        "forceSecureNotification": false
      },
      {
        "recipients": [
          "recipient2@host.com",
          "Recipient Name <recipient2@host.com>"
        ],
        "headers": {
          "subject": "sample email",
          "from": "sender@authorized_domain.com",
          "reply-to": "Sender Name <sender@authorized_domain.com>"
        },
        "content": {
          "text/plain": "Hello World!",
          "text/html": "<html><body><h1>Hello World!</h1></body></html>"
        },
        "attachments": [
          {
            "fileName": "hello_world.txt",
            "contentType": "text/plain",
            "content": "SGVsbG8gV29ybGQh"
          }
        ]
      }
    ]
  }
}
'
{
  "messages": [
    {
      "sourceTrackingId": "3d38ab13-0af8-4028-bd45-999999999999",
      "customHeaders": {
        "X-Custom-Header": "value"
      },
      "data": "Service OK"
    },
    {
      "sourceTrackingId": "3d38ab13-0af8-4028-bd45-000000000000",
      "customHeaders": {
        "X-Custom-Header": "value"
      },
      "data": "Service OK"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.paubox.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Paubox API uses a custom token format in the Authorization header.

IMPORTANT: You must prefix your API key with "Token token="

Format: Authorization: Token token=YOUR_API_KEY_HERE

Example: Authorization: Token token=9e5b092b632445b8f570c62ae54f30fda1044305

Do NOT use just the API key alone or Bearer token format.

Body

application/json
​
data
object
required

Response

Batch accepted

​
messages
object[]