Skip to main content
POST

Authorizations

Authorization
string
header
required

Your Mailercloud API key (plain text, no Bearer prefix). Create keys in Settings → API.

Headers

Content-Type
string
default:application/json
required

Request body type

Body

application/json
name
string
required
Required string length: 1 - 150
sender
object
required
subject
string
required
Required string length: 1 - 65000
email_preheader
string
exclude_list_ids
string[]
exclude_segments
string[]
exclude_tag_ids
string[]
frequency_cap
string
html
string
is_publish
enum<string>

"1" publishes/schedules the campaign; "0" saves it as a draft.

Available options:
0,
1
list_ids
string[]
mailing_preference
boolean
pause_rules
object
permission_reminder
string
plain_text
string
reply_email
string
reply_id
string
report_spam
boolean
rules
object
scheduled_at
string

Schedule time in YYYY-MM-DD HH:MM:SS format. Omit to send according to is_publish.

segments
string[]
sender_id
string[]
tag_id
string
tag_ids
string[]
tag_name
string

Response

{ "id": "a" }

id
string

ID of the created campaign.