Send up to 100 messages, each with its own recipient and data

POST

/api/v1/workspaces/{workspace}/transactional/messages/batch

# REPUTECAST_API_KEY: an API key (rc_live_…) with transactional:send. Up to 100 messages per call.
# Replace reputecast.example.com with your public URL and your-workspace with your workspace slug.
curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/your-workspace/transactional/messages/batch \
  --header "Authorization: Bearer $REPUTECAST_API_KEY" \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: welcome-2026-10-22-0900' \
  --data '{
    "messages": [
      {
        "template": "welcome",
        "to": { "email": "[email protected]", "name": "Priya Shah" },
        "data": { "first_name": "Priya", "dashboard_url": "https://app.example.com/" }
      },
      {
        "template": "welcome",
        "to": { "email": "[email protected]" },
        "data": { "dashboard_url": "https://app.example.com/" }
      }
    ]
  }'

// REPUTECAST_API_KEY: an API key (rc_live_…) with transactional:send. Up to 100 messages per call.
// Replace reputecast.example.com with your public URL and your-workspace with your workspace slug.
const response = await fetch(
  'https://reputecast.example.com/api/v1/workspaces/your-workspace/transactional/messages/batch',
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.REPUTECAST_API_KEY}`,
      'Content-Type': 'application/json',
      // A retry of the same batch within 24 hours never sends twice.
      'Idempotency-Key': 'welcome-2026-10-22-0900',
    },
    body: JSON.stringify({
      messages: [
        {
          template: 'welcome',
          to: { email: '[email protected]', name: 'Priya Shah' },
          data: { first_name: 'Priya', dashboard_url: 'https://app.example.com/' },
        },
        {
          template: 'welcome',
          to: { email: '[email protected]' },
          data: { dashboard_url: 'https://app.example.com/' },
        },
      ],
    }),
  },
)
const result = await response.json()
if (!response.ok) throw new Error(`${response.status} ${result.code}: ${result.detail}`)
console.log(`${result.accepted} accepted, ${result.failed} failed`)
// One result per message, in the order sent: its ID and status, or the problem that stopped it.
for (const item of result.results) {
  console.log(item.index, item.status, item.id ?? `${item.error.code}: ${item.error.detail}`)
}

// REPUTECAST_API_KEY: an API key (rc_live_…) with transactional:send. Up to 100 messages per call.
// Replace reputecast.example.com with your public URL and your-workspace with your workspace slug.
package main

import (
  "bytes"
  "encoding/json"
  "fmt"
  "log"
  "net/http"
  "os"
)

func main() {
  body, err := json.Marshal(map[string]any{
    "messages": []map[string]any{
      {
        "template": "welcome",
        "to":       map[string]string{"email": "[email protected]", "name": "Priya Shah"},
        "data":     map[string]string{"first_name": "Priya", "dashboard_url": "https://app.example.com/"},
      },
      {
        "template": "welcome",
        "to":       map[string]string{"email": "[email protected]"},
        "data":     map[string]string{"dashboard_url": "https://app.example.com/"},
      },
    },
  })
  if err != nil {
    log.Fatal(err)
  }
  req, err := http.NewRequest(http.MethodPost,
    "https://reputecast.example.com/api/v1/workspaces/your-workspace/transactional/messages/batch", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }
  req.Header.Set("Authorization", "Bearer "+os.Getenv("REPUTECAST_API_KEY"))
  req.Header.Set("Content-Type", "application/json")
  // A retry of the same batch within 24 hours never sends twice.
  req.Header.Set("Idempotency-Key", "welcome-2026-10-22-0900")

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  type problem struct {
    Code   string `json:"code"`
    Detail string `json:"detail"`
  }
  var result struct {
    problem
    Accepted int `json:"accepted"`
    Failed   int `json:"failed"`
    Results  []struct {
      Index  int      `json:"index"`
      Status string   `json:"status"`
      ID     string   `json:"id"`
      Error  *problem `json:"error"`
    } `json:"results"`
  }
  if err := json.NewDecoder(resp.Body).Decode(&result); err != nil {
    log.Fatal(err)
  }
  if resp.StatusCode >= 300 {
    log.Fatalf("%d %s: %s", resp.StatusCode, result.Code, result.Detail)
  }
  fmt.Printf("%d accepted, %d failed\n", result.Accepted, result.Failed)
  // One result per message, in the order sent: its ID and status, or the problem that stopped it.
  for _, item := range result.Results {
    if item.Error != nil {
      fmt.Println(item.Index, item.Status, item.Error.Code+": "+item.Error.Detail)
      continue
    }
    fmt.Println(item.Index, item.Status, item.ID)
  }
}

# REPUTECAST_API_KEY: an API key (rc_live_…) with transactional:send. Up to 100 messages per call.
# Replace reputecast.example.com with your public URL and your-workspace with your workspace slug.
import os

import requests

response = requests.post(
    "https://reputecast.example.com/api/v1/workspaces/your-workspace/transactional/messages/batch",
    headers={
        "Authorization": f"Bearer {os.environ['REPUTECAST_API_KEY']}",
        # A retry of the same batch within 24 hours never sends twice.
        "Idempotency-Key": "welcome-2026-10-22-0900",
    },
    json={
        "messages": [
            {
                "template": "welcome",
                "to": {"email": "[email protected]", "name": "Priya Shah"},
                "data": {"first_name": "Priya", "dashboard_url": "https://app.example.com/"},
            },
            {
                "template": "welcome",
                "to": {"email": "[email protected]"},
                "data": {"dashboard_url": "https://app.example.com/"},
            },
        ]
    },
    timeout=30,
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{response.status_code} {result.get('code')}: {result.get('detail')}")
print(f"{result['accepted']} accepted, {result['failed']} failed")
# One result per message, in the order sent: its ID and status, or the problem that stopped it.
for item in result["results"]:
    if "error" in item:
        print(item["index"], item["status"], f"{item['error']['code']}: {item['error']['detail']}")
    else:
        print(item["index"], item["status"], item["id"])

<?php
// REPUTECAST_API_KEY: an API key (rc_live_…) with transactional:send. Up to 100 messages per call.
// Replace reputecast.example.com with your public URL and your-workspace with your workspace slug.
$payload = [
    'messages' => [
        [
            'template' => 'welcome',
            'to' => ['email' => '[email protected]', 'name' => 'Priya Shah'],
            'data' => ['first_name' => 'Priya', 'dashboard_url' => 'https://app.example.com/'],
        ],
        [
            'template' => 'welcome',
            'to' => ['email' => '[email protected]'],
            'data' => ['dashboard_url' => 'https://app.example.com/'],
        ],
    ],
];

$ch = curl_init('https://reputecast.example.com/api/v1/workspaces/your-workspace/transactional/messages/batch');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('REPUTECAST_API_KEY'),
        'Content-Type: application/json',
        // A retry of the same batch within 24 hours never sends twice.
        'Idempotency-Key: welcome-2026-10-22-0900',
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_THROW_ON_ERROR),
]);
$body = curl_exec($ch);
if ($body === false) {
    throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
$result = json_decode($body, true, flags: JSON_THROW_ON_ERROR);
if ($status >= 300) {
    throw new RuntimeException("{$status} {$result['code']}: {$result['detail']}");
}
echo "{$result['accepted']} accepted, {$result['failed']} failed", PHP_EOL;
// One result per message, in the order sent: its ID and status, or the problem that stopped it.
foreach ($result['results'] as $item) {
    $outcome = isset($item['error']) ? "{$item['error']['code']}: {$item['error']['detail']}" : $item['id'];
    echo "{$item['index']} {$item['status']} {$outcome}", PHP_EOL;
}

Permission: transactional:send (sensitive)

Each message gets its own answer in results, in the order sent: its ID and status, or the problem that stopped it (the same codes as one send).

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Header Parameters

Idempotency-Key

A retry of the same batch within 24 hours never sends twice

string

<= 255 characters

A retry of the same batch within 24 hours never sends twice

Request Body^required

application/json

object

messages

required

Array<object>

>= 1 items <= 100 items

object

attachments

Array<object>

<= 20 items

object

content

required

The file, base64-encoded

string

content_id

Makes it an inline image the HTML references as cid:<content_id>

string

<= 200 characters

content_type

Guessed from the file name when omitted

string

<= 200 characters

filename

required

string

>= 1 characters <= 255 characters

bcc

Array<object>

<= 20 items

object

email

required

string

<= 254 characters

name

string

<= 200 characters

Array<object>

<= 20 items

object

email

required

string

<= 254 characters

name

string

<= 200 characters

data

The template’s variables

object

key

additional properties

from

A verified Transactional sender, as an address or “Name

”; the template’s sender when omitted

string

<= 320 characters

language

The language version to send; the linked contact’s language, then the fallback, when omitted

string

<= 16 characters

metadata

object

key

additional properties

string

preheader

Overrides the template’s preheader (Liquid)

string

<= 500 characters

reply_to

string

<= 320 characters

send_at

Send later, up to 72 hours ahead

string format: date-time

subject

Overrides the template’s subject (Liquid)

string

<= 998 characters

tags

Returned with every webhook event of the message

Array<string>

<= 10 items

template

required

The template’s ID

string

>= 1 characters <= 64 characters

required

object

email

required

string

<= 254 characters

name

string

<= 200 characters

Responses

200

application/json

object

accepted

required

integer format: int64

failed

required

integer format: int64

results

required

Array<object>

object

error

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

missing

Required variables the call didn’t send (missing_variables)

Array<string>

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

string

index

required

integer format: int64

send_at

string format: date-time

status

required

string

Allowed values: queued scheduled not_delivered error

test

boolean

Example

{
  "results": [
    {
      "error": {
        "detail": "Property foo is required but is missing.",
        "instance": "https://example.com/error-log/abc123",
        "status": 400,
        "title": "Bad Request",
        "type": "about:blank"
      },
      "status": "queued"
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}

Send up to 100 messages, each with its own recipient and data

Authorizations

Parameters

Path Parameters

Header Parameters

Request Bodyrequired

Responses

200

Example

default

Example

Request Body^required