KosmoKrator

email

MailerLite Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the MailerLite KosmoKrator integration.

8 functions 4 read 4 write API key auth
Submit MailerLite feedback View package source

Lua Namespace

Agents call this integration through app.integrations.mailerlite.*. Use lua_read_doc("integrations.mailerlite") inside KosmoKrator to discover the same reference at runtime.

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Mailerlite — Lua API Reference

mailerlite_add_subscriber_to_group

Add a subscriber to a MailerLite group by providing the group ID and subscriber email..

Parameters

NameTypeRequiredDescription
group_idstringyesThe group ID to add the subscriber to.
emailstringyesSubscriber email address.
namestringnoSubscriber name (used if creating a new subscriber).

Example

local result = app.integrations.mailerlite.mailerlite_add_subscriber_to_group({
  group_id = ""
  email = ""
  name = ""
})

mailerlite_create_subscriber

Add a new subscriber to MailerLite. Provide an email address and optionally a name and custom fields..

Parameters

NameTypeRequiredDescription
emailstringyesSubscriber email address.
namestringnoSubscriber name.
fieldsstringnoCustom fields as key-value pairs (e.g., {

Example

local result = app.integrations.mailerlite.mailerlite_create_subscriber({
  email = ""
  name = ""
  fields = ""
})

mailerlite_delete_subscriber

Delete a subscriber from MailerLite by their ID. This action is permanent..

Parameters

NameTypeRequiredDescription
idstringyesThe subscriber ID to delete.

Example

local result = app.integrations.mailerlite.mailerlite_delete_subscriber({
  id = ""
})

mailerlite_get_current_user

Get the currently authenticated MailerLite account information. Useful for verifying API credentials..

Example

local result = app.integrations.mailerlite.mailerlite_get_current_user({
})

mailerlite_get_subscriber

Get details for a single MailerLite subscriber by their ID..

Parameters

NameTypeRequiredDescription
idstringyesThe subscriber ID.

Example

local result = app.integrations.mailerlite.mailerlite_get_subscriber({
  id = ""
})

mailerlite_list_groups

List subscriber groups (segments) from MailerLite. Supports pagination..

Parameters

NameTypeRequiredDescription
pageintegernoPage number (default: 1).
limitintegernoNumber of groups per page (default: 25).

Example

local result = app.integrations.mailerlite.mailerlite_list_groups({
  page = 0
  limit = 0
})

mailerlite_list_subscribers

List subscribers from MailerLite. Supports pagination and filtering by status (active, unsubscribed, etc.)..

Parameters

NameTypeRequiredDescription
pageintegernoPage number (default: 1).
limitintegernoNumber of subscribers per page (default: 25, max: 100).
statusstringnoFilter by status: active, unsubscribed, unconfirmed, bounced, junk.

Example

local result = app.integrations.mailerlite.mailerlite_list_subscribers({
  page = 0
  limit = 0
  status = ""
})

mailerlite_update_subscriber

Update an existing subscriber in MailerLite. Provide the subscriber ID and fields to update..

Parameters

NameTypeRequiredDescription
idstringyesThe subscriber ID.
namestringnoUpdated subscriber name.
fieldsstringnoUpdated custom fields as key-value pairs.

Example

local result = app.integrations.mailerlite.mailerlite_update_subscriber({
  id = ""
  name = ""
  fields = ""
})
Raw agent markdown 
# Mailerlite — Lua API Reference

## mailerlite_add_subscriber_to_group

Add a subscriber to a MailerLite group by providing the group ID and subscriber email..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `group_id` | string | yes | The group ID to add the subscriber to. |
| `email` | string | yes | Subscriber email address. |
| `name` | string | no | Subscriber name (used if creating a new subscriber). |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_add_subscriber_to_group({
  group_id = ""
  email = ""
  name = ""
})
```

## mailerlite_create_subscriber

Add a new subscriber to MailerLite. Provide an email address and optionally a name and custom fields..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `email` | string | yes | Subscriber email address. |
| `name` | string | no | Subscriber name. |
| `fields` | string | no | Custom fields as key-value pairs (e.g., { |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_create_subscriber({
  email = ""
  name = ""
  fields = ""
})
```

## mailerlite_delete_subscriber

Delete a subscriber from MailerLite by their ID. This action is permanent..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string | yes | The subscriber ID to delete. |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_delete_subscriber({
  id = ""
})
```

## mailerlite_get_current_user

Get the currently authenticated MailerLite account information. Useful for verifying API credentials..

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_get_current_user({
})
```

## mailerlite_get_subscriber

Get details for a single MailerLite subscriber by their ID..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string | yes | The subscriber ID. |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_get_subscriber({
  id = ""
})
```

## mailerlite_list_groups

List subscriber groups (segments) from MailerLite. Supports pagination..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `page` | integer | no | Page number (default: 1). |
| `limit` | integer | no | Number of groups per page (default: 25). |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_list_groups({
  page = 0
  limit = 0
})
```

## mailerlite_list_subscribers

List subscribers from MailerLite. Supports pagination and filtering by status (active, unsubscribed, etc.)..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `page` | integer | no | Page number (default: 1). |
| `limit` | integer | no | Number of subscribers per page (default: 25, max: 100). |
| `status` | string | no | Filter by status: active, unsubscribed, unconfirmed, bounced, junk. |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_list_subscribers({
  page = 0
  limit = 0
  status = ""
})
```

## mailerlite_update_subscriber

Update an existing subscriber in MailerLite. Provide the subscriber ID and fields to update..

### Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `id` | string | yes | The subscriber ID. |
| `name` | string | no | Updated subscriber name. |
| `fields` | string | no | Updated custom fields as key-value pairs. |

### Example

```lua
local result = app.integrations.mailerlite.mailerlite_update_subscriber({
  id = ""
  name = ""
  fields = ""
})
```

Metadata-Derived Lua Example

local result = app.integrations.mailerlite.mailerlite_list_subscribers({
  page = 1,
  limit = 1,
  status = "example_status"
})
print(result)

Functions

mailerlite_list_subscribers

List subscribers from MailerLite. Supports pagination and filtering by status (active, unsubscribed, etc.).

Operation
Read read
Full name
mailerlite.mailerlite_list_subscribers
ParameterTypeRequiredDescription
page integer no Page number (default: 1).
limit integer no Number of subscribers per page (default: 25, max: 100).
status string no Filter by status: active, unsubscribed, unconfirmed, bounced, junk.

mailerlite_get_subscriber

Get details for a single MailerLite subscriber by their ID.

Operation
Read read
Full name
mailerlite.mailerlite_get_subscriber
ParameterTypeRequiredDescription
id string yes The subscriber ID.

mailerlite_create_subscriber

Add a new subscriber to MailerLite. Provide an email address and optionally a name and custom fields.

Operation
Write write
Full name
mailerlite.mailerlite_create_subscriber
ParameterTypeRequiredDescription
email string yes Subscriber email address.
name string no Subscriber name.
fields object no Custom fields as key-value pairs (e.g., {"company": "Acme"}).

mailerlite_update_subscriber

Update an existing subscriber in MailerLite. Provide the subscriber ID and fields to update.

Operation
Write write
Full name
mailerlite.mailerlite_update_subscriber
ParameterTypeRequiredDescription
id string yes The subscriber ID.
name string no Updated subscriber name.
fields object no Updated custom fields as key-value pairs.

mailerlite_delete_subscriber

Delete a subscriber from MailerLite by their ID. This action is permanent.

Operation
Write write
Full name
mailerlite.mailerlite_delete_subscriber
ParameterTypeRequiredDescription
id string yes The subscriber ID to delete.

mailerlite_list_groups

List subscriber groups (segments) from MailerLite. Supports pagination.

Operation
Read read
Full name
mailerlite.mailerlite_list_groups
ParameterTypeRequiredDescription
page integer no Page number (default: 1).
limit integer no Number of groups per page (default: 25).

mailerlite_add_subscriber_to_group

Add a subscriber to a MailerLite group by providing the group ID and subscriber email.

Operation
Write write
Full name
mailerlite.mailerlite_add_subscriber_to_group
ParameterTypeRequiredDescription
group_id string yes The group ID to add the subscriber to.
email string yes Subscriber email address.
name string no Subscriber name (used if creating a new subscriber).

mailerlite_get_current_user

Get the currently authenticated MailerLite account information. Useful for verifying API credentials.

Operation
Read read
Full name
mailerlite.mailerlite_get_current_user
ParameterTypeRequiredDescription
No parameters.