Skip to main content
POST
email.campaign.create

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
name
string
required

Your own name for the campaign.

Required string length: 1 - 200
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)*$
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)*$
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
lists
string[]
required

Contact lists to send to, by name.

Required array length: 1 - 20 elements

The contact list's name, as email.contact-lists.list shows it.

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

Preview text shown before opening.

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

Sender display name.

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

Where replies go.

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

Contact lists whose contacts are left out.

Maximum array length: 20

The contact list's name, as email.contact-lists.list shows it.

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

Response

The result

status
string
required

Saved, not sent. Send it with email.campaign.send.

Allowed value: "draft"
ref
string

Reference to what this call created. Pass it as ref to email.campaign.send and email.campaign.status.