GuidesAPI Reference
API Reference

/campaigns

post
https://api.mailerlite.com/api/v2/campaigns

Create campaign where you will use your custom HTML template [Rate limited]

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Email type of created campaign

Campaigns that are created using this endpoint require your own custom HTML templates to be added via API using /campaigns/:id/content endpoint or directly in MailerLite application.

Here is more details about ab_settings object.

All fields are required!

ParameterTypeDescription
valuesarray

Must contain two values. It depends on send_type.

For example, if send_type equals to sender these values are used as sender names for AB test.

If send_type equals to subject these values are used as subjects for AB test.

send_typestring

Available values:

- sender
- subject

ab_win_typestring

It defines how winner will be selected.

Available values:

- opens
- clicks

winner_afterinteger

It defines how long AB test is active.

Pay attention that this is only a number and type is defined as winner_after_type

winner_after_typestring

Available values:

- d - days
- h - hours

split_partinteger

It defines size of every test group in percents equally.

Available range: 5-25

Body Params
string
required
Defaults to null

Type of campaign. Available values: regular, ab.

string
required
Defaults to campaign name

The internal name for the campaign

groups
array of int32s
required
Defaults to

IDs of groups. Required if segments are not specified.

groups*
segments
array of int32s
required
Defaults to

IDs of segments. Required if groups are not specified. If specified, groups are ignored. If you're using legacy subscriber management, this parameter will be ignored.

segments*
string

Mail subject. Required if campaign type is regular.

string
Defaults to Account's default sender

Email of sender

string
Defaults to Account's default sender

Name of sender

string
Defaults to Account's default language code

Available languages and its code's: https://developers-classic.mailerlite.com/reference#language

Responses

Updated 15 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 15 days ago