Skip to content

MailerLite

Note

As of March 22, 2022, new users will not be able to use the v2 API until Mailerlite completely releases the new API.

With the MailerLite modules in Ibexa Connect, you can:

  • Watch, list, create, execute the campaign action, upload the campaign content, and remove the campaign.

  • Watch, search, retrieve, list, add, and update the subscribers.

  • List, retrieve, create, update, and remove the groups.

  • List and retrieve the group subscribers, remove subscribers from the group, and list group subscribers by type.

To get started with the MailerLite app, create an account at Mailerlite.com.

Note

The module dialog fields that are displayed in bold (in the Ibexa Connect, not in this documentation article) are mandatory!

Connect the MailerLite to Ibexa Connect

To connect the MailerLite app with the Ibexa Connect:

  1. Log in to your MailerLite account.

    MailerLite_3.png

  2. Click your account name in the left side panel and select Integrations.

    MailerLite_4.png

  3. From the list of integrations, choose Developer API > Use.

    MailerLite_5.png

  4. Click New, enter a name for the new API token, and click Create token.

    MailerLite_6.png

  5. Now copy the API key to a safe place.

    MailerLite_7.png

  6. Log in to your Ibexa Connect and add a module from the MailerLite into a Ibexa Connect scenario.

  7. Click Add next to the Connection field.

    MailerLite.gif

  8. In the Connection name field, enter a name for the connection.

  9. In the API Key field, enter the details copied in step 5 and click Save.

You have successfully connected the MailerLite app with Ibexa Connect and can now build and run your scenario.

Campaign

You can watch, create, list, execute, remove, and update the campaign content using the following modules.

Watch Campaigns

Runs when a new campaign is added to your account.

Campaign status

Select or map the campaign status:

  • Sent

  • Draft

  • Outbox

List Campaigns

Lists all campaigns by status.

Campaign status

Select or map the campaign status:

  • Sent

  • Draft

  • Outbox

Create Campaign

Creates campaign where you will use your custom HTML template.

Type of campaign

Select the type of campaign:

  • Regular

  • AB

Mail subject

Enter (map) a subject line to display in the recipient's email.

Settings

Enter the details of the settings:

Send type

Select the type of send:

  • Sender

  • Subject

Sender

Enter (map) the sender names for the AB testing campaign.

Subjects

Enter (map) the sender names for the AB testing campaign.

Win type

Select the win type:

  • Opens

  • Clicks

Winner after (units)

Select the units for winner after:

  • Days

  • Hours

Winner after

Enter (map) a time in hours how long AB test campaign should be active.

Split part

Enter (map) the size of every test group in percent equally to a value lower than or equal to 25.

IDs of groups

Select or map the group IDs to which you want to send the campaign.

Email of sender

Enter (map) the sender's email address.

Name of sender

Enter (map) the sender's name.

Language

Select or map the language in which the mail should be sent.

Execute Campaign Action

Sends, schedules, or cancels campaigns.

Campaign ID

Enter (map) a Campaign ID for which you want to execute an action.

Action

Select the action you want to execute:

  • Send

  • Cancel

Type

Select or map the option to send the campaign actions:

  • Send Instantly

  • Schedule Send

Followup Schedule

Select or map an option for followup schedule:

  • Followup mail is sent in 24 hours

  • Specific Time

Followup Date

Enter (map) the followup date for the campaign in YYYY-MM-DD format. See the list of supported date and time formats.

Date

Enter (map) the date for the campaign in YYYY-MM-DD format. See the list of supported date and time formats.

Timezone ID

Select or map the Timezone ID for the campaign.

Followup timezone ID

Select or map the Followup Timezone ID for the campaign.

Analytics

Select or map the analytics for the campaign:

  • Enabled

  • Diabled

Upload Campaign Content

Uploads your HTML template to created campaign.

Campaign ID Enter (map) a Campaign ID whose details you want to update.
HTML Content Enter (map) the HTML template source for the campaign content.
Plain Text Content Enter (map) the plain text body of the campaign email to be sent.
Auto inline CSS Select whether to convert available CSS to inline CSS for the campaign content.

Remove Campaign

Removes a campaign.

Campaign ID Enter (map) a Campaign ID you want to delete.

Subscriber

Watch Subscribers

Triggers when an event occurs to subscribers.

Webhook name Enter (map) a name for the webhook.
Event Select an event to watch.

Search Subscribers By Email

Searches for subscribers by email.

Email Enter (map) an Email ID to search for the subscriber. Note Email should be at least 3 characters long.

Get Subscriber

Gets single subscriber by ID or Email.

Subscriber ID or Email Enter (map) a Subscriber ID or Email to retrieve a subscriber.

List Subscriber Activity

Lists activity (clicks, opens, etc) of selected subscribers.

Subscriber ID or Email Enter (map) a Subscriber ID or Email to list the subscriber's activity.

List Subscriber Activity By Type

Lists activity of selected subscriber by specified type (opens, clicks, etc).

Subscriber ID or Email

Enter (map) a Subscriber ID or Email of the subscriber whose activity you want to list.

Activity type

Select the type of activity:

  • Opens

  • Clicks

  • Junks

  • Bounces

  • Unsubscribes

  • Forwards

  • Sendings

Add Subscriber to a Group

Adds new single subscribers to the specified group.

Group ID

Select or map a Group ID of the group to add a subscriber to the group.

Email

Enter (map) the Email ID of the new subscriber.

Custom Fields

Enter (map) the details of the custom fields.

Email

Enter (map) the Email ID of the subscriber.

City

Enter (map) the city name of the subscriber.

Company

Enter (map) the company name of the subscriber.

Country

Enter (map) the country name of the subscriber.

Last name

Enter (map) the Last name of the subscriber.

Name

Enter (map) the name of the subscriber.

Phone

Enter (map) the phone number of the subscriber.

State

Enter (map) the state of the subscriber.

ZIP

Enter (map) the zip code of the subscriber.

Resubscribe

Select whether to reactivate the subscriber.

Autoresponders

Select whether to send the autoresponders.

Type

Select the type of group:

  • Subscribed

  • Active

  • Unconfirmed

Update Subscriber

Updates single subscriber by ID or Email.

Subscriber ID or Email

Enter (map) a Subscriber ID or Email of the subscriber whose details you want to update.

Type

Select the type of subscriber:

  • Unsubscribed

  • Active

Custom Fields

Enter (map) the details of the custom fields.

Email

Enter (map) the Email ID of the subscriber.

City

Enter (map) the city of the subscriber.

Company

Enter (map) the company name of the subscriber.

Country

Enter (map) the country name of the subscriber.

Last name

Enter (map) the last name of the subscriber.

Name

Enter (map) the name of the subscriber.

Phone

Enter (map) the phone number of the subscriber.

State

Enter (map) the state name of the subscriber.

ZIP

Enter (map) the ZIP code of the subscriber.

Resend Autoresponders

Select whether to resend autoresponders.

Group

You can create, update, retrieve, list, and remove subscribers and subscriber groups using the following module.

List Groups

Lists all groups for this account.

List Subscriber Groups

Lists groups subscriber belongs to.

Subscriber ID or Email Enter (map) a subscriber's Subscriber ID or email address whose groups you want to list.

Get Group

Gets single group by ID.

Group ID Enter (map) a Group ID whose details you want to retrieve.

Create Group

Creates a new group.

Group Name Enter (map) a name for the group.

Update Group

Updates existing group.

Existing Group ID Enter (map) a Group ID whose details you want to update.
New Group Name Enter (map) a new name for the group.

Remove Group

Removes group by ID.

Group ID Select or map a Group ID you want to delete.

Group Subscriber

You can list, retrieve, and remove the group subscribers using the following module.

List Group Subscribers

Lists all subscribers in a specified group.

Group ID Select or map a Group ID to list the group subscriber.

List Group Subscribers By Type

Lists all subscribers in a specified group by type.

Group ID

Select or map a Group to list group subscribers.

Subscriber type

Select the type of subscriber:

  • Active

  • Unsubscribed

  • Bounced

  • Junk

  • Unconfirmed

Get Group Subscriber

Gets a single subscriber by ID in specified group.

Group ID Select or map a Group ID to list a subscriber from the group.
Subscriber ID Enter (map) a Subscriber ID to retrieve the group subscriber.

Remove Subscriber From Group

Removes a single subscriber from a specified group.

Group ID Select or map a Group ID to whose subscriber you want to remove.
Subscriber ID or Email Enter (map) a Subscriber ID to retrieve to remove the subscriber from the group.

Other

You can call APIs using the following module.

Make an API Call

Performs an arbitrary authorized API call.

URL

Enter a path relative to https://api.mailerlite.com/api. For example, /v2/groups

For the list of available endpoints, refer to the MailerLite API documentation

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - List fields

The following API call lists all the available fields in your MailerLite account:

URL:

/v2/fields

Method:

GET

MailerLite_2.png

Matches of the search can be found in the module's Output under Bundles > Body.

In our example, 9 fields have returned:

MailerLite_1.png