Skip to main content
POST
/
v1
/
emails
/
batch
cURL
curl --request POST \
  --url https://api.transmit.dev/v1/emails/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "from": "<string>",
    "to": "jsmith@example.com",
    "from_name": "<string>",
    "reply_to": "jsmith@example.com",
    "cc": "jsmith@example.com",
    "bcc": "jsmith@example.com",
    "subject": "<string>",
    "html": "<string>",
    "text": "<string>",
    "template_id": "<string>",
    "template_friendly_name": "<string>",
    "variables": {},
    "tags": [
      "<string>"
    ],
    "headers": {},
    "attachments": [
      {
        "filename": "<string>",
        "content": "<string>",
        "type": "<string>",
        "contentId": "<string>"
      }
    ],
    "scheduled_for": "2023-11-07T05:31:56Z",
    "batch_id": "<string>",
    "track_opens": true,
    "track_clicks": true
  }
]
'
{
  "data": [
    {
      "id": "<string>"
    }
  ]
}

Authorizations

ā€‹
Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Body

application/json
Required array length: 1 - 100 elements
ā€‹
from
string
required
Minimum string length: 1
Pattern: ^.+@.+\..+$
ā€‹
to
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
from_name
string
ā€‹
reply_to
string<email>
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
cc
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
bcc
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
ā€‹
subject
string
Minimum string length: 1
ā€‹
html
string
ā€‹
text
string
ā€‹
template_id
string
ā€‹
template_friendly_name
string
ā€‹
variables
object
ā€‹
tags
string[]
ā€‹
headers
object
ā€‹
attachments
object[]
ā€‹
scheduled_for
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
ā€‹
batch_id
string
ā€‹
message_stream
enum<string>
Available options:
transactional,
broadcast
ā€‹
track_opens
boolean
ā€‹
track_clicks
boolean

Response

Batch accepted for processing

ā€‹
data
object[]
required

Array of results for each email in the batch