Send an email

POST

/emails/send

const url = 'https://mail.teamander.com/v1/emails/send';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'order-1234-receipt',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"to":"jane@example.com","from":"billing@yourdomain.com","subject":"Your receipt","template_id":"receipt","data":{"name":"Jane","amount":"$42.00"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://mail.teamander.com/v1/emails/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: order-1234-receipt' \
  --data '{ "to": "jane@example.com", "from": "billing@yourdomain.com", "subject": "Your receipt", "template_id": "receipt", "data": { "name": "Jane", "amount": "$42.00" } }'

Queues a transactional email for one or up to 50 recipients. Provide one of template_id, html, or text. Pass an Idempotency-Key header to make retries safe — a repeated key returns the original result with idempotent_replay: true and never sends twice. Custom headers values are stripped of CR/LF to prevent header injection.

Authorizations

bearerAuth

Parameters

Header Parameters

Idempotency-Key

Unique key to make the send idempotent across retries

string

<= 255 characters

Example

order-1234-receipt

Request Body

application/json

object

required

Any of:

string
Array<string>

string format: email

from

string format: email

subject

string

template_id

string

>= 1 characters <= 50 characters

data

object

key

additional properties

nullable

html

string

text

string

metadata

object

key

additional properties

nullable

headers

object

key

additional properties

string

Example

{
  "to": "jane@example.com",
  "from": "billing@yourdomain.com",
  "subject": "Your receipt",
  "template_id": "receipt",
  "data": {
    "name": "Jane",
    "amount": "$42.00"
  }
}

Responses

200

Idempotent replay of a previous send

application/json

object

queued

required

Array<object>

object

required

string

recipient

required

string

status

required

string

suppressed

Array<string>

idempotent_replay

boolean

Example

{
  "queued": [
    {
      "id": "a1b2c3d4-...",
      "recipient": "jane@example.com",
      "status": "sent"
    }
  ],
  "idempotent_replay": true
}

201

Queued

application/json

object

queued

required

Array<object>

object

required

string

recipient

required

string

status

required

string

suppressed

Array<string>

idempotent_replay

boolean

Example

{
  "queued": [
    {
      "id": "a1b2c3d4-...",
      "recipient": "jane@example.com",
      "status": "queued"
    }
  ]
}

400

Validation failed

application/json

object

error

required

string

details

object

key

additional properties

nullable

Example

{
  "error": "Validation failed",
  "details": {}
}

401

Missing or invalid API key

application/json

object

error

required

string

message

string

Example

{
  "error": "Invalid API key"
}

429

Rate limit or monthly quota exceeded

application/json

object

error

required

string

message

string

Example

{
  "error": "Monthly email limit exceeded"
}