ByteChef LogoByteChef

MailerLite

MailerLite is an intuitive email marketing platform that offers automation, landing pages, and subscriber management for businesses and creators.

Categories: Marketing Automation

Type: mailerLite/v1


Connections

Version: 1

bearer_token

Properties

NameLabelTypeDescriptionRequired
tokenAPI TokenSTRINGAPI Token needed for authorization.true

Connection Setup

Find API Token

  1. Navigate to your MailerLite dashboard.
  2. Click on Integrations.
  3. Click on API.
  4. Click on Generate new token.
  5. Enter name of your API token.
  6. Enable Terms of Use.
  7. Click on Create token.
  8. Copy your API token because you will not be able to see the full token again.
  9. Exit the popup window.

Actions

Add Subscriber to Group

Name: addSubscriberToGroup

Adding a subscriber to a selected group.

Properties

NameLabelTypeDescriptionRequired
subscriber_idSubscriber EmailSTRINGID of the user that will be added to the selected group.true
group_idGroup IDSTRINGID of the group to which the user will be added.true

Example JSON Structure

{
  "label" : "Add Subscriber to Group",
  "name" : "addSubscriberToGroup",
  "parameters" : {
    "subscriber_id" : "",
    "group_id" : ""
  },
  "type" : "mailerLite/v1/addSubscriberToGroup"
}

Output

Type: OBJECT

Properties

NameTypeDescription
dataOBJECT
Properties {STRING(id), STRING(name), INTEGER(active_count), INTEGER(sent_count), INTEGER(opens_count), {NUMBER(float), STRING(string)}(open_rate), INTEGER(clicks_count), {NUMBER(float), STRING(string)}(click_rate), INTEGER(unsubscribed_count), INTEGER(unconfirmed_count), INTEGER(bounced_count), INTEGER(junk_count), STRING(created_at)}

Output Example

{
  "data" : {
    "id" : "",
    "name" : "",
    "active_count" : 1,
    "sent_count" : 1,
    "opens_count" : 1,
    "open_rate" : {
      "float" : 0.0,
      "string" : ""
    },
    "clicks_count" : 1,
    "click_rate" : {
      "float" : 0.0,
      "string" : ""
    },
    "unsubscribed_count" : 1,
    "unconfirmed_count" : 1,
    "bounced_count" : 1,
    "junk_count" : 1,
    "created_at" : ""
  }
}

Find Subscriber ID

To find the Subscriber ID, click here.

Find Group ID

To find the Group ID, click here.

Create or Update Subscriber

Name: createOrUpdateSubscriber

Create new user or update an existing user.

Properties

NameLabelTypeDescriptionRequired
emailnullSTRINGThe email address of the subscriber.true
group_idGroup IDSTRINGID of the group to which you want to add the subscriber to.false

Example JSON Structure

{
  "label" : "Create or Update Subscriber",
  "name" : "createOrUpdateSubscriber",
  "parameters" : {
    "email" : "",
    "group_id" : ""
  },
  "type" : "mailerLite/v1/createOrUpdateSubscriber"
}

Output

Type: OBJECT

Properties

NameTypeDescription
dataOBJECT
Properties {STRING(id), STRING(email), STRING(status), STRING(source), INTEGER(sent), INTEGER(opens_count), INTEGER(clicks_count), INTEGER(open_rate), INTEGER(click_rate), STRING(subscribed_at), STRING(created_at), STRING(updated_at), [](fields), [](groups)}

Output Example

{
  "data" : {
    "id" : "",
    "email" : "",
    "status" : "",
    "source" : "",
    "sent" : 1,
    "opens_count" : 1,
    "clicks_count" : 1,
    "open_rate" : 1,
    "click_rate" : 1,
    "subscribed_at" : "",
    "created_at" : "",
    "updated_at" : "",
    "fields" : [ ],
    "groups" : [ ]
  }
}

Find Group ID

To find the Group ID, click here.

Remove Subscriber from Group

Name: removeSubscriberFromGroup

Remove selected subscriber from the group.

Properties

NameLabelTypeDescriptionRequired
subscriber_idSubscriberSTRINGID of the user that will be added to the selected group.true
group_idGroup IDSTRINGID of the group to which the user will be added.true

Example JSON Structure

{
  "label" : "Remove Subscriber from Group",
  "name" : "removeSubscriberFromGroup",
  "parameters" : {
    "subscriber_id" : "",
    "group_id" : ""
  },
  "type" : "mailerLite/v1/removeSubscriberFromGroup"
}

Output

This action does not produce any output.

Find Subscriber ID

To find the Subscriber ID, click here.

Find Group ID

To find the Group ID, click here.

Triggers

Subscriber Added to the Group

Name: subscriberAddedToGroup

Triggers when a subscriber is added to the group.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
dataOBJECT
Properties {STRING(account_id), STRING(id), STRING(email), STRING(status), STRING(source), INTEGER(sent), INTEGER(opens_count), INTEGER(clicks_count), INTEGER(open_rate), INTEGER(click_rate), STRING(subscribed_at), STRING(created_at), STRING(updated_at), [](fields), [](groups)}

JSON Example

{
  "label" : "Subscriber Added to the Group",
  "name" : "subscriberAddedToGroup",
  "type" : "mailerLite/v1/subscriberAddedToGroup"
}

Subscriber Created

Name: subscriberCreated

Triggers when a subscriber is created.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
dataOBJECT
Properties {STRING(id), STRING(email), STRING(status), STRING(source), INTEGER(sent), INTEGER(opens_count), INTEGER(clicks_count), INTEGER(open_rate), INTEGER(click_rate), {}(ip_address), STRING(subscribed_at), STRING(unsubscribed_at), STRING(created_at), STRING(updated_at), STRING(deleted_at), STRING(forget_at), [](fields), [](groups), STRING(account_id)}

JSON Example

{
  "label" : "Subscriber Created",
  "name" : "subscriberCreated",
  "type" : "mailerLite/v1/subscriberCreated"
}

Subscriber Unsubscribed

Name: subscriberUnsubscribed

Triggers when a subscriber unsubscribes.

Type: DYNAMIC_WEBHOOK

Output

Type: OBJECT

Properties

NameTypeDescription
dataOBJECT
Properties {STRING(account_id), STRING(id), STRING(email), STRING(status), STRING(source), INTEGER(sent), INTEGER(opens_count), INTEGER(clicks_count), INTEGER(open_rate), INTEGER(click_rate), STRING(subscribed_at), STRING(created_at), STRING(updated_at), [](fields), [](groups)}

JSON Example

{
  "label" : "Subscriber Unsubscribed",
  "name" : "subscriberUnsubscribed",
  "type" : "mailerLite/v1/subscriberUnsubscribed"
}

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.


Additional Instructions

How to find the Subscriber ID

  1. Login into your MailerLite account.
  2. Click on Subscribers in left side panel.
  3. Find subscriber you want to find ID of and click on it.
  4. In the URL from your browser's address bar.
  5. Copy the value that appears after subscribers/.

Example

Given the URL:

https://dashboard.mailerlite.com/subscribers/190607012343580336

The Subscriber ID is:

190607012343580336

How to find the Group ID

  1. Login into your MailerLite account.
  2. Click on Subscribers in left side panel.
  3. Click on Groups tab.
  4. Find group you want to find ID of and click on View group.
  5. Copy the URL from your browser's address bar.
  6. Find the group query parameter in the URL.
  7. Copy the value that appears after group=.

Example

Given the URL:

https://dashboard.mailerlite.com/subscribers?...&group=150651902266180716

The Group ID is:

150651902266180716

How is this guide?

Last updated on

On this page