MailerLite

[Caution] Caution

Accounts created before March 22, 2022, must use MailerLite Classic. Accounts created after March 22nd, 2022, use the MailerLite app.

For new MailerLite accounts, you can use either API V2 or API V1.

For more information regarding the MailerLite Classic and new MailerLite versions, see the MailerLite vs MailerLite Classic documentation.

With MailerLite modules in Boost.space Integrator, you can:

  • watch subscriber events, create, update, retrieve, list, and delete subscribers, and add and remove subscribers from a group

  • create, update, retrieve, list, and delete groups

  • watch new and sent campaigns, create, update, retrieve, list, schedule, and remove campaigns, cancel a ready campaign

  • call APIs

To get started with MailerLite, create an account at mailerlite.com.

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

Connect MailerLite to Boost.space Integrator

To connect MailerLite app, you need to obtain the API Key.

  1. Log in to your MailerLite account.

  2. Choose the app you want to connect to.

    • MailerLite Classic: supports only the API v1.

    • MailerLite: supports both API v1 and v2.

    mailerlite-12.png
  3. Click your account name in the left side panel and select Integrations.

    MailerLite_1.png
  4. From the list of integrations, choose MailerLite API > Use.

    MailerLite_2.png
  5. Click Generate New Token, enter a name for the new API token, and click Create token. Agree that you have understood the requirements by selecting the checkbox that appears.

    MailerLite_3.png
  6. Now copy the API key to a safe place.

    MailerLite_4.png
  7. In your Boost.space Integrator account, insert a MailerLite module in your scenario and click the Add button next to the Connection field.

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

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

You have successfully established the connection. You can now edit your scenario and add more MailerLite modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Subscribers

You can watch subscriber events, create, update, retrieve, list, and delete subscribers, and add and remove subscribers from a group using the following modules.

Watch Subscriber Events

Triggers when a selected event is executed.

Webhook name

Enter (map) a name for the webhook.

Connection

Establish a connection to your MailerLite account.

Event

Select an event to watch.

Create/Update a Subscriber

Creates a new subscriber or update an existing one if the email already exists.

For field descriptions, see the MailerLite Subscribers API reference.

Get a Subscriber

Gets a subscriber by ID or Email.

Connection

Establish a connection to your MailerLite account.

Subscriber ID or Email

Select or map a Subscriber ID or Email whose details you want to retrieve.

Delete a Subscriber

Deletes subscriber by ID.

Connection

Establish a connection to your MailerLite account.

Subscriber ID

Select or map the Subscriber ID you want to delete.

List Subscribers

Lists all subscribers or filter by status and group.

Connection

Establish a connection to your MailerLite account.

Status

Select the status:

  • Active

  • Unsubscribed

  • Unconfirmed

  • Bounced

  • Junk

Group ID

Select or map the Group ID whose subscribers you want to list.

Limit

Set the maximum number of subscribers Boost.space Integrator will return during one execution cycle.

Add Subscriber to a Group

Adds the selected subscriber to the specified group.

Connection

Establish a connection to your MailerLite account.

Subscriber ID

Select or map the Subscriber ID you want to add to a group.

Group ID

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

Remove Subscriber from a Group

Remove the selected subscriber from the specified group.

Connection

Establish a connection to your MailerLite account.

Subscriber ID

Select or map the Subscriber ID you want to remove from a group.

Group ID

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

Groups

You can create, update, retrieve, list, and delete groups using the following modules.

Create a Group

Creates a new group.

Connection

Establish a connection to your MailerLite account.

Group Name

Enter (map) a name for the group.

Get a Group

Gets a group by its ID.

Connection

Establish a connection to your MailerLite account.

Group ID

Select or map the Group ID whose details you want to retrieve.

Update a Group

Updates group by its ID.

Connection

Establish a connection to your MailerLite account.

Group ID

Select or map the Group ID whose details you want to update.

Name

Enter (map) a new name for the group.

Delete a Group

Deletes group by its ID.

Connection

Establish a connection to your MailerLite account.

Group ID

Select or map the Group ID you want to delete.

List Groups

Lists all groups for this account.

Connection

Establish a connection to your MailerLite account.

Name

Enter a name to the groups by name.

Limit

Set the maximum number of groups Boost.space Integrator will return during one execution cycle.

Campaigns

You can watch new and sent campaigns, create, update, retrieve, list, schedule, and remove campaigns, and cancel a ready campaign using the following modules.

Watch New Campaigns

Triggers when a new campaign is created.

Connection

Establish a connection to your MailerLite account.

Status

Select the status:

  • Sent

  • Draft

  • Ready

Limit

Set the maximum number of campaigns Boost.space Integrator will return during one execution cycle. The default value is 2.

Watch Sent Campaigns

Triggers when a campaign is sent.

Webhook name

Enter a name for the webhook.

Connection

Establish a connection to your MailerLite account.

Create a Campaign

Creates a new campaign of type Regular, A/B Split, or Auto resend. Not available for RSS campaigns.

For field descriptions, see the MailerLite Campaign API reference.

Get a Campaign

Retrieves selected campaign by its ID.

Connection

Establish a connection to your MailerLite account.

Campaign ID

Enter a Campaign ID whose details you want to retrieve. Alternatively, you can search for a campaign:

Campaign Status

Select the status:

  • Sent

  • Draft

  • Ready

Update a Campaign

Updates selected campaign by its ID.

For field descriptions, see the MailerLite Subscribers API reference.

Delete a Campaign

Removes selected campaign.

Connection

Establish a connection to your MailerLite account.

Campaign ID

Enter a Campaign ID whose details you want to retrieve. Alternatively, you can search for a campaign:

Campaign Status

Select the status:

  • Sent

  • Draft

  • Ready

Cancel a Ready Campaign

Cancels selected campaign.

Connection

Establish a connection to your MailerLite account.

Campaign ID

Select or map the Campaign ID you want to cancel.

List Campaigns

Lists all campaigns.

Connection

Establish a connection to your MailerLite account.

Status

Select the status:

  • Sent

  • Draft

  • Ready

Type

Select the type:

  • Regular

  • AB

  • Resend

  • RSS

Limit

Set the maximum number of campaigns Boost.space Integrator will return during one execution cycle.

Schedule a Campaign

Schedules a Regular, A/B or Auto resend campaign. Not available for RSS campaigns.

Connection

Establish a connection to your MailerLite account.

Campaign ID

Select or map a Campaign ID you want to schedule.

[Note] Note

Only draft campaigns can be scheduled.

Delivery

Select the delivery:

  • Send instantly

  • Schedule Delivery

  • Timezone Based Delivery

Resend

Select the delivery of the second email:

  • Day

  • Scheduled

For field descriptions, see the MailerLite Campaign API reference.

Other

You can call APIs using the following module.

List Segments

List all segments.

Connection

Establish a connection to your MailerLite account.

Limit

Set the maximum number of segments Boost.space Integrator will return during one execution cycle.

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your MailerLite account.

URL

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

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 Groups

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

URL:/groups

Method:GET

MailerLite_7.png

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

In our example, 3 groups were returned:

MailerLite_6.png