Skip to main content
POST
email.marketing.send

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
from
string
required

Sender address on a domain you verified for marketing with email.domain.verify (use: marketing). Never Pramaan's managed domain.

Required string length: 1 - 320
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
to
string[]
required

Up to 100 recipients. Each gets their own copy; suppressed and unsubscribed people are skipped.

Required array length: 1 - 100 elements
Required string length: 1 - 320
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
subject
string
required

Subject line.

Required string length: 1 - 998
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
html
string
required

HTML body. Put {{unsubscribe}} (or {{unsubscribe_preference}}) in a link; when missing, an unsubscribe footer is added.

Required string length: 1 - 500000
fromName
string

Sender display name.

Required string length: 1 - 200
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
replyTo
string[]

Where replies go, as a one-item list.

Required array length: 1 element
Required string length: 1 - 320
Pattern: ^(?:[^\p{Cc}\p{Zl}\p{Zp}]|\t)*$
text
string

Plain-text body.

Required string length: 1 - 500000

Response

The result

status
string
required

Handed off for sending; not proof of delivery.

Allowed value: "queued"
accepted
number
required

Recipients accepted for sending, each charged one email.

skipped
number
required

Recipients not mailed because they unsubscribed or are suppressed (free).

failed
number
required

Recipients the service refused (free).