Post v1emailsbatch

Send up to 100 emails in a single request. Each email can have up to 50 recipients.

POST /v1/emails/batch

cURL

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": "[e-mail]",
    "from_name": "<string>",
    "reply_to": "[e-mail]",
    "cc": "[e-mail]",
    "bcc": "[e-mail]",
    "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
  }
]
'

import requests

url = "https://api.transmit.dev/v1/emails/batch"

payload = [
    {
        "from": "<string>",
        "to": "[e-mail]",
        "from_name": "<string>",
        "reply_to": "[e-mail]",
        "cc": "[e-mail]",
        "bcc": "[e-mail]",
        "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
    }
]
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      from: '<string>',
      to: '[e-mail]',
      from_name: '<string>',
      reply_to: '[e-mail]',
      cc: '[e-mail]',
      bcc: '[e-mail]',
      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
    }
  ])
};

fetch('https://api.transmit.dev/v1/emails/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.transmit.dev/v1/emails/batch",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'from' => '<string>',
        'to' => '[e-mail]',
        'from_name' => '<string>',
        'reply_to' => '[e-mail]',
        'cc' => '[e-mail]',
        'bcc' => '[e-mail]',
        '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.transmit.dev/v1/emails/batch"

	payload := strings.NewReader("[\n  {\n    \"from\": \"<string>\",\n    \"to\": \"[e-mail]\",\n    \"from_name\": \"<string>\",\n    \"reply_to\": \"[e-mail]\",\n    \"cc\": \"[e-mail]\",\n    \"bcc\": \"[e-mail]\",\n    \"subject\": \"<string>\",\n    \"html\": \"<string>\",\n    \"text\": \"<string>\",\n    \"template_id\": \"<string>\",\n    \"template_friendly_name\": \"<string>\",\n    \"variables\": {},\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"headers\": {},\n    \"attachments\": [\n      {\n        \"filename\": \"<string>\",\n        \"content\": \"<string>\",\n        \"type\": \"<string>\",\n        \"contentId\": \"<string>\"\n      }\n    ],\n    \"scheduled_for\": \"2023-11-07T05:31:56Z\",\n    \"batch_id\": \"<string>\",\n    \"track_opens\": true,\n    \"track_clicks\": true\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.transmit.dev/v1/emails/batch")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"from\": \"<string>\",\n    \"to\": \"[e-mail]\",\n    \"from_name\": \"<string>\",\n    \"reply_to\": \"[e-mail]\",\n    \"cc\": \"[e-mail]\",\n    \"bcc\": \"[e-mail]\",\n    \"subject\": \"<string>\",\n    \"html\": \"<string>\",\n    \"text\": \"<string>\",\n    \"template_id\": \"<string>\",\n    \"template_friendly_name\": \"<string>\",\n    \"variables\": {},\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"headers\": {},\n    \"attachments\": [\n      {\n        \"filename\": \"<string>\",\n        \"content\": \"<string>\",\n        \"type\": \"<string>\",\n        \"contentId\": \"<string>\"\n      }\n    ],\n    \"scheduled_for\": \"2023-11-07T05:31:56Z\",\n    \"batch_id\": \"<string>\",\n    \"track_opens\": true,\n    \"track_clicks\": true\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.transmit.dev/v1/emails/batch")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"from\": \"<string>\",\n    \"to\": \"[e-mail]\",\n    \"from_name\": \"<string>\",\n    \"reply_to\": \"[e-mail]\",\n    \"cc\": \"[e-mail]\",\n    \"bcc\": \"[e-mail]\",\n    \"subject\": \"<string>\",\n    \"html\": \"<string>\",\n    \"text\": \"<string>\",\n    \"template_id\": \"<string>\",\n    \"template_friendly_name\": \"<string>\",\n    \"variables\": {},\n    \"tags\": [\n      \"<string>\"\n    ],\n    \"headers\": {},\n    \"attachments\": [\n      {\n        \"filename\": \"<string>\",\n        \"content\": \"<string>\",\n        \"type\": \"<string>\",\n        \"contentId\": \"<string>\"\n      }\n    ],\n    \"scheduled_for\": \"2023-11-07T05:31:56Z\",\n    \"batch_id\": \"<string>\",\n    \"track_opens\": true,\n    \"track_clicks\": true\n  }\n]"

response = http.request(request)
puts response.read_body

202

{
  "data": [
    {
      "id": "<string>"
    }
  ]
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

{
  "code": "<string>",
  "message": "<string>",
  "statusCode": 123,
  "details": "<unknown>"
}

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 · string<email> string<email>[] · 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 · string<email> string<email>[]

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

bcc · string<email> string<email>[]

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

Show child attributes

tags · string[]

headers · object

Show child attributes

attachments · object[]

Show child attributes

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

202

application/json

Batch accepted for processing

data · object[] · required

Array of results for each email in the batch

Option 1

Option 2

Show child attributes