productivity
MailerLite Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the MailerLite KosmoKrator integration.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.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
MailerLite workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.mailerlite.list_subscribers({cursor = "example_cursor", limit = 1, status = "example_status", include = "example_include"}))' --jsonkosmo integrations:lua --eval 'print(docs.read("mailerlite"))' --json
kosmo integrations:lua --eval 'print(docs.read("mailerlite.list_subscribers"))' --jsonWorkflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local mailerlite = app.integrations.mailerlite
local result = mailerlite.list_subscribers({cursor = "example_cursor", limit = 1, status = "example_status", include = "example_include"})
dump(result)kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json Namespace note.
integrations:lua exposes app.integrations.mailerlite, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.mailerlite.default.* or app.integrations.mailerlite.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need MailerLite, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --jsonAgent-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
Namespace: app.integrations.mailerlite
Use these tools to manage subscribers, groups, segments, fields, automations, campaigns, forms, webhooks, and batch requests through the current MailerLite API.
Subscribers
mailerlite_list_subscribers({ limit, cursor, status, include })mailerlite_get_subscriber({ id })mailerlite_create_subscriber({ email, fields, groups, status })mailerlite_update_subscriber({ id, fields, groups, status, subscribed_at })mailerlite_delete_subscriber({ id })mailerlite_list_subscriber_activity({ id, ["filter[log_name]"], limit, page })
id can be a subscriber ID or email address for subscriber fetch/update/delete calls. include = "groups" includes group data in subscriber lists.
Groups
mailerlite_list_groups({ limit, page })mailerlite_create_group({ name })mailerlite_update_group({ group_id, name })mailerlite_delete_group({ group_id })mailerlite_list_group_subscribers({ group_id, ["filter[status]"], limit, cursor })mailerlite_add_subscriber_to_group({ group_id, email, name })mailerlite_assign_subscriber_to_group({ subscriber_id, group_id })mailerlite_unassign_subscriber_from_group({ subscriber_id, group_id })mailerlite_import_subscribers_to_group({ group_id, subscribers })
mailerlite_add_subscriber_to_group creates or updates a subscriber and includes the group in the subscriber payload. Use the assign/unassign tools when you already have the MailerLite subscriber ID.
Segments And Fields
mailerlite_list_segments({ limit, page })mailerlite_list_segment_subscribers({ segment_id, ["filter[status]"], limit, cursor })mailerlite_update_segment({ segment_id, name })mailerlite_delete_segment({ segment_id })mailerlite_list_fields({ limit, page })mailerlite_create_field({ name, type })mailerlite_update_field({ field_id, name })mailerlite_delete_field({ field_id })
Field type must be text, number, or date.
Automations
mailerlite_list_automations({ ["filter[enabled]"], ["filter[name]"], ["filter[group]"], page, limit })mailerlite_get_automation({ automation_id })mailerlite_list_automation_activity({ automation_id, page, limit })mailerlite_create_automation({ name })mailerlite_create_automation({ payload = {...} })mailerlite_delete_automation({ automation_id })
Automation creation creates a draft automation. Use payload when MailerLite requires fields beyond name.
Campaigns
mailerlite_list_campaigns({ ["filter[status]"], ["filter[type]"], ["filter[name]"], sort, page, limit })mailerlite_get_campaign({ campaign_id })mailerlite_create_campaign({ payload = {...} })mailerlite_update_campaign({ campaign_id, payload = {...} })mailerlite_schedule_campaign({ campaign_id, payload = {...} })mailerlite_cancel_campaign({ campaign_id })mailerlite_delete_campaign({ campaign_id })mailerlite_list_campaign_subscriber_activity({ campaign_id, page, limit })
Campaign create/update payloads are passed through to MailerLite so agents can supply the documented type, name, emails, groups, segments, and scheduling fields without the integration dropping nested data.
Forms
mailerlite_list_forms({ type, ["filter[name]"], sort, page, limit })mailerlite_get_form({ form_id })mailerlite_update_form({ form_id, payload = {...} })mailerlite_delete_form({ form_id })mailerlite_list_form_subscribers({ form_id, page, limit })
Form type must be popup, embedded, or promotion.
Webhooks
mailerlite_list_webhooks({ page, limit })mailerlite_get_webhook({ webhook_id })mailerlite_create_webhook({ name, events, url, enabled, batchable })mailerlite_update_webhook({ webhook_id, name, events, url, enabled, batchable })mailerlite_delete_webhook({ webhook_id })
Supported webhook event names include subscriber events such as subscriber.created, subscriber.updated, and campaign events such as campaign.sent, campaign.open, and campaign.click. MailerLite requires batchable = true for some high-volume events.
Utilities
mailerlite_batch({ requests = {...} })mailerlite_get_current_user({})mailerlite_api_get({ path, params })mailerlite_api_post({ path, payload })mailerlite_api_put({ path, payload })mailerlite_api_patch({ path, payload })mailerlite_api_delete({ path, payload })
Batch request objects must use MailerLite’s documented method, path, and optional body keys. Raw API helper paths must be relative paths like /subscribers; absolute URLs are rejected.
Examples
local created = app.integrations.mailerlite.mailerlite_create_subscriber({
email = "reader@example.test",
fields = {
name = "Ada Example",
company = "Example Co"
},
groups = {"1234567890"},
status = "active"
})local activity = app.integrations.mailerlite.mailerlite_list_campaign_subscriber_activity({
campaign_id = "66200823885989563",
limit = 50
})local webhook = app.integrations.mailerlite.mailerlite_create_webhook({
name = "Subscriber events",
url = "https://example.test/mailerlite",
events = {"subscriber.created", "subscriber.updated"},
enabled = true
})Raw agent markdown
# MailerLite Lua API
Namespace: `app.integrations.mailerlite`
Use these tools to manage subscribers, groups, segments, fields, automations, campaigns, forms, webhooks, and batch requests through the current MailerLite API.
## Subscribers
- `mailerlite_list_subscribers({ limit, cursor, status, include })`
- `mailerlite_get_subscriber({ id })`
- `mailerlite_create_subscriber({ email, fields, groups, status })`
- `mailerlite_update_subscriber({ id, fields, groups, status, subscribed_at })`
- `mailerlite_delete_subscriber({ id })`
- `mailerlite_list_subscriber_activity({ id, ["filter[log_name]"], limit, page })`
`id` can be a subscriber ID or email address for subscriber fetch/update/delete calls. `include = "groups"` includes group data in subscriber lists.
## Groups
- `mailerlite_list_groups({ limit, page })`
- `mailerlite_create_group({ name })`
- `mailerlite_update_group({ group_id, name })`
- `mailerlite_delete_group({ group_id })`
- `mailerlite_list_group_subscribers({ group_id, ["filter[status]"], limit, cursor })`
- `mailerlite_add_subscriber_to_group({ group_id, email, name })`
- `mailerlite_assign_subscriber_to_group({ subscriber_id, group_id })`
- `mailerlite_unassign_subscriber_from_group({ subscriber_id, group_id })`
- `mailerlite_import_subscribers_to_group({ group_id, subscribers })`
`mailerlite_add_subscriber_to_group` creates or updates a subscriber and includes the group in the subscriber payload. Use the assign/unassign tools when you already have the MailerLite subscriber ID.
## Segments And Fields
- `mailerlite_list_segments({ limit, page })`
- `mailerlite_list_segment_subscribers({ segment_id, ["filter[status]"], limit, cursor })`
- `mailerlite_update_segment({ segment_id, name })`
- `mailerlite_delete_segment({ segment_id })`
- `mailerlite_list_fields({ limit, page })`
- `mailerlite_create_field({ name, type })`
- `mailerlite_update_field({ field_id, name })`
- `mailerlite_delete_field({ field_id })`
Field `type` must be `text`, `number`, or `date`.
## Automations
- `mailerlite_list_automations({ ["filter[enabled]"], ["filter[name]"], ["filter[group]"], page, limit })`
- `mailerlite_get_automation({ automation_id })`
- `mailerlite_list_automation_activity({ automation_id, page, limit })`
- `mailerlite_create_automation({ name })`
- `mailerlite_create_automation({ payload = {...} })`
- `mailerlite_delete_automation({ automation_id })`
Automation creation creates a draft automation. Use `payload` when MailerLite requires fields beyond `name`.
## Campaigns
- `mailerlite_list_campaigns({ ["filter[status]"], ["filter[type]"], ["filter[name]"], sort, page, limit })`
- `mailerlite_get_campaign({ campaign_id })`
- `mailerlite_create_campaign({ payload = {...} })`
- `mailerlite_update_campaign({ campaign_id, payload = {...} })`
- `mailerlite_schedule_campaign({ campaign_id, payload = {...} })`
- `mailerlite_cancel_campaign({ campaign_id })`
- `mailerlite_delete_campaign({ campaign_id })`
- `mailerlite_list_campaign_subscriber_activity({ campaign_id, page, limit })`
Campaign create/update payloads are passed through to MailerLite so agents can supply the documented `type`, `name`, `emails`, `groups`, `segments`, and scheduling fields without the integration dropping nested data.
## Forms
- `mailerlite_list_forms({ type, ["filter[name]"], sort, page, limit })`
- `mailerlite_get_form({ form_id })`
- `mailerlite_update_form({ form_id, payload = {...} })`
- `mailerlite_delete_form({ form_id })`
- `mailerlite_list_form_subscribers({ form_id, page, limit })`
Form `type` must be `popup`, `embedded`, or `promotion`.
## Webhooks
- `mailerlite_list_webhooks({ page, limit })`
- `mailerlite_get_webhook({ webhook_id })`
- `mailerlite_create_webhook({ name, events, url, enabled, batchable })`
- `mailerlite_update_webhook({ webhook_id, name, events, url, enabled, batchable })`
- `mailerlite_delete_webhook({ webhook_id })`
Supported webhook event names include subscriber events such as `subscriber.created`, `subscriber.updated`, and campaign events such as `campaign.sent`, `campaign.open`, and `campaign.click`. MailerLite requires `batchable = true` for some high-volume events.
## Utilities
- `mailerlite_batch({ requests = {...} })`
- `mailerlite_get_current_user({})`
- `mailerlite_api_get({ path, params })`
- `mailerlite_api_post({ path, payload })`
- `mailerlite_api_put({ path, payload })`
- `mailerlite_api_patch({ path, payload })`
- `mailerlite_api_delete({ path, payload })`
Batch request objects must use MailerLite's documented `method`, `path`, and optional `body` keys. Raw API helper paths must be relative paths like `/subscribers`; absolute URLs are rejected.
## Examples
```lua
local created = app.integrations.mailerlite.mailerlite_create_subscriber({
email = "reader@example.test",
fields = {
name = "Ada Example",
company = "Example Co"
},
groups = {"1234567890"},
status = "active"
})
```
```lua
local activity = app.integrations.mailerlite.mailerlite_list_campaign_subscriber_activity({
campaign_id = "66200823885989563",
limit = 50
})
```
```lua
local webhook = app.integrations.mailerlite.mailerlite_create_webhook({
name = "Subscriber events",
url = "https://example.test/mailerlite",
events = {"subscriber.created", "subscriber.updated"},
enabled = true
})
```local result = app.integrations.mailerlite.list_subscribers({cursor = "example_cursor", limit = 1, status = "example_status", include = "example_include"})
print(result)Functions
list_subscribers Read
List subscribers from MailerLite. Supports cursor pagination, status filtering, and groups include.
- Lua path
app.integrations.mailerlite.list_subscribers- Full name
mailerlite.mailerlite_list_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
cursor | string | no | Cursor from a previous response. |
limit | integer | no | Number of subscribers to return (default: 25). |
status | string | no | Filter by status: active, unsubscribed, unconfirmed, bounced, junk. |
include | string | no | Additional resource include. Currently groups is supported. |
get_subscriber Read
Get details for a single MailerLite subscriber by ID or email address.
- Lua path
app.integrations.mailerlite.get_subscriber- Full name
mailerlite.mailerlite_get_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The subscriber ID or email address. |
create_or_upsert_subscriber Write
Add a new subscriber to MailerLite. Provide an email address and optionally a name and custom fields.
- Lua path
app.integrations.mailerlite.create_or_upsert_subscriber- Full name
mailerlite.mailerlite_create_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | yes | Subscriber email address. |
name | string | no | Subscriber name. |
fields | object | no | Custom fields as key-value pairs. |
groups | array | no | Group IDs to add the subscriber to. |
status | string | no | Subscriber status. |
update_subscriber Write
Update an existing subscriber in MailerLite. Provide the subscriber ID and fields to update.
- Lua path
app.integrations.mailerlite.update_subscriber- Full name
mailerlite.mailerlite_update_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The subscriber ID or email address. |
name | string | no | Updated subscriber name. |
fields | object | no | Updated custom fields as key-value pairs. |
groups | array | no | Complete group ID list for the subscriber. Omitted groups are removed by the API. |
status | string | no | Subscriber status. |
subscribed_at | string | no | Subscription date as yyyy-MM-dd HH:mm:ss. |
delete_subscriber Write
Delete a subscriber from MailerLite by their ID. This action is permanent.
- Lua path
app.integrations.mailerlite.delete_subscriber- Full name
mailerlite.mailerlite_delete_subscriber
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | The subscriber ID or email address to delete. |
list_subscriber_activity Read
List activity log entries for a subscriber with optional log-name, cursor, and limit filters.
- Lua path
app.integrations.mailerlite.list_subscriber_activity- Full name
mailerlite.mailerlite_list_subscriber_activity
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Subscriber ID. |
filter[log_name] | string | no | Activity type filter such as email_open, link_click, unsubscribed, or campaign_send. |
limit | integer | no | Maximum rows to return. |
page | integer | no | Page number. |
list_groups Read
List subscriber groups (segments) from MailerLite. Supports pagination.
- Lua path
app.integrations.mailerlite.list_groups- Full name
mailerlite.mailerlite_list_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number (default: 1). |
limit | integer | no | Number of groups per page (default: 25). |
create_group Write
Create a subscriber group by name.
- Lua path
app.integrations.mailerlite.create_group- Full name
mailerlite.mailerlite_create_group
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Group name. |
update_group Write
Update a subscriber group name.
- Lua path
app.integrations.mailerlite.update_group- Full name
mailerlite.mailerlite_update_group
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
name | string | yes | Updated group name. |
delete_group Write
Delete a subscriber group by ID.
- Lua path
app.integrations.mailerlite.delete_group- Full name
mailerlite.mailerlite_delete_group
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
list_group_subscribers Read
List subscribers belonging to a group with cursor pagination and status filtering.
- Lua path
app.integrations.mailerlite.list_group_subscribers- Full name
mailerlite.mailerlite_list_group_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
filter[status] | string | no | Subscriber status filter. |
limit | integer | no | Maximum rows to return. |
cursor | string | no | Cursor from a prior response. |
add_subscriber_group Write
Add a subscriber to a MailerLite group by providing the group ID and subscriber email.
- Lua path
app.integrations.mailerlite.add_subscriber_group- Full name
mailerlite.mailerlite_add_subscriber_to_group
| Parameter | 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 stored in the name field when creating or updating the subscriber. |
assign_subscriber_group Write
Assign an existing subscriber to a group by subscriber ID and group ID.
- Lua path
app.integrations.mailerlite.assign_subscriber_group- Full name
mailerlite.mailerlite_assign_subscriber_to_group
| Parameter | Type | Required | Description |
|---|---|---|---|
subscriber_id | string | yes | Existing subscriber ID. |
group_id | string | yes | Existing group ID. |
unassign_subscriber_from_group Write
Remove an existing subscriber from a group by subscriber ID and group ID.
- Lua path
app.integrations.mailerlite.unassign_subscriber_from_group- Full name
mailerlite.mailerlite_unassign_subscriber_from_group
| Parameter | Type | Required | Description |
|---|---|---|---|
subscriber_id | string | yes | Existing subscriber ID. |
group_id | string | yes | Existing group ID. |
import_subscribers_group Write
Bulk import subscriber payloads into a group and return the import progress URL.
- Lua path
app.integrations.mailerlite.import_subscribers_group- Full name
mailerlite.mailerlite_import_subscribers_to_group
| Parameter | Type | Required | Description |
|---|---|---|---|
group_id | string | yes | Group ID. |
subscribers | array | yes | Array of subscriber objects to import. |
list_segments Read
List audience segments with pagination.
- Lua path
app.integrations.mailerlite.list_segments- Full name
mailerlite.mailerlite_list_segments
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum rows to return. |
page | integer | no | Page number. |
list_segment_subscribers Read
List subscribers in a segment with cursor pagination and status filtering.
- Lua path
app.integrations.mailerlite.list_segment_subscribers- Full name
mailerlite.mailerlite_list_segment_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
segment_id | string | yes | Segment ID. |
filter[status] | string | no | Subscriber status filter. |
limit | integer | no | Maximum rows to return. |
cursor | string | no | Cursor from a prior response. |
update_segment Write
Update a segment name.
- Lua path
app.integrations.mailerlite.update_segment- Full name
mailerlite.mailerlite_update_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
segment_id | string | yes | Segment ID. |
name | string | yes | Updated segment name. |
delete_segment Write
Delete a segment by ID.
- Lua path
app.integrations.mailerlite.delete_segment- Full name
mailerlite.mailerlite_delete_segment
| Parameter | Type | Required | Description |
|---|---|---|---|
segment_id | string | yes | Segment ID. |
list_fields Read
List custom subscriber fields.
- Lua path
app.integrations.mailerlite.list_fields- Full name
mailerlite.mailerlite_list_fields
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Maximum rows to return. |
page | integer | no | Page number. |
create_field Write
Create a custom subscriber field. Type must be text, number, or date.
- Lua path
app.integrations.mailerlite.create_field- Full name
mailerlite.mailerlite_create_field
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | yes | Field name. |
type | string | yes | Field type. |
update_field Write
Update a custom field name.
- Lua path
app.integrations.mailerlite.update_field- Full name
mailerlite.mailerlite_update_field
| Parameter | Type | Required | Description |
|---|---|---|---|
field_id | string | yes | Field ID. |
name | string | yes | Updated field name. |
delete_field Write
Delete a custom subscriber field by ID.
- Lua path
app.integrations.mailerlite.delete_field- Full name
mailerlite.mailerlite_delete_field
| Parameter | Type | Required | Description |
|---|---|---|---|
field_id | string | yes | Field ID. |
list_automations Read
List automations with optional enabled, name, and group filters.
- Lua path
app.integrations.mailerlite.list_automations- Full name
mailerlite.mailerlite_list_automations
| Parameter | Type | Required | Description |
|---|---|---|---|
filter[enabled] | boolean | no | Filter active or inactive automations. |
filter[name] | string | no | Partial name filter. |
filter[group] | string | no | Group ID filter. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
get_automation Read
Get an automation by ID, including its configured steps and stats.
- Lua path
app.integrations.mailerlite.get_automation- Full name
mailerlite.mailerlite_get_automation
| Parameter | Type | Required | Description |
|---|---|---|---|
automation_id | string | yes | Automation ID. |
list_automation_activity Read
List subscriber activity for an automation.
- Lua path
app.integrations.mailerlite.list_automation_activity- Full name
mailerlite.mailerlite_list_automation_activity
| Parameter | Type | Required | Description |
|---|---|---|---|
automation_id | string | yes | Automation ID. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
create_automation Write
Create a draft automation. Use payload for advanced automation fields or name for a simple draft.
- Lua path
app.integrations.mailerlite.create_automation- Full name
mailerlite.mailerlite_create_automation
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | no | Automation name. |
payload | object | no | Full automation payload. |
delete_automation Write
Delete an automation by ID.
- Lua path
app.integrations.mailerlite.delete_automation- Full name
mailerlite.mailerlite_delete_automation
| Parameter | Type | Required | Description |
|---|---|---|---|
automation_id | string | yes | Automation ID. |
list_campaigns Read
List campaigns with optional status, type, name, sort, and pagination filters.
- Lua path
app.integrations.mailerlite.list_campaigns- Full name
mailerlite.mailerlite_list_campaigns
| Parameter | Type | Required | Description |
|---|---|---|---|
filter[status] | string | no | Campaign status filter. |
filter[type] | string | no | Campaign type filter. |
filter[name] | string | no | Partial name filter. |
sort | string | no | Sort field, optionally prefixed with minus for descending order. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
get_campaign Read
Get a campaign by ID.
- Lua path
app.integrations.mailerlite.get_campaign- Full name
mailerlite.mailerlite_get_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
create_campaign Write
Create a campaign. Use payload for the full MailerLite campaign body including emails, groups, segments, and settings.
- Lua path
app.integrations.mailerlite.create_campaign- Full name
mailerlite.mailerlite_create_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
payload | object | yes | Campaign creation payload. |
update_campaign Write
Update a campaign. Use payload for the full MailerLite update body.
- Lua path
app.integrations.mailerlite.update_campaign- Full name
mailerlite.mailerlite_update_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
payload | object | yes | Campaign update payload. |
schedule_campaign Write
Schedule a campaign. Use payload for MailerLite scheduling fields.
- Lua path
app.integrations.mailerlite.schedule_campaign- Full name
mailerlite.mailerlite_schedule_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
payload | object | no | Schedule payload, such as delivery time or immediate-send settings. |
cancel_campaign Write
Cancel a campaign send when the campaign is still in a cancelable state.
- Lua path
app.integrations.mailerlite.cancel_campaign- Full name
mailerlite.mailerlite_cancel_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
delete_campaign Write
Delete a campaign by ID.
- Lua path
app.integrations.mailerlite.delete_campaign- Full name
mailerlite.mailerlite_delete_campaign
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
list_campaign_subscriber_activity Read
List subscriber activity for a sent campaign, including opens, clicks, bounces, and unsubscribes.
- Lua path
app.integrations.mailerlite.list_campaign_subscriber_activity- Full name
mailerlite.mailerlite_list_campaign_subscriber_activity
| Parameter | Type | Required | Description |
|---|---|---|---|
campaign_id | string | yes | Campaign ID. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
list_forms Read
List forms by type: popup, embedded, or promotion.
- Lua path
app.integrations.mailerlite.list_forms- Full name
mailerlite.mailerlite_list_forms
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | yes | Form type. |
filter[name] | string | no | Partial name filter. |
sort | string | no | Sort field, optionally prefixed with minus for descending order. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
get_form Read
Get a form by ID.
- Lua path
app.integrations.mailerlite.get_form- Full name
mailerlite.mailerlite_get_form
| Parameter | Type | Required | Description |
|---|---|---|---|
form_id | string | yes | Form ID. |
update_form Write
Update a form. Use payload for the full MailerLite form update body.
- Lua path
app.integrations.mailerlite.update_form- Full name
mailerlite.mailerlite_update_form
| Parameter | Type | Required | Description |
|---|---|---|---|
form_id | string | yes | Form ID. |
payload | object | yes | Form update payload. |
delete_form Write
Delete a form by ID.
- Lua path
app.integrations.mailerlite.delete_form- Full name
mailerlite.mailerlite_delete_form
| Parameter | Type | Required | Description |
|---|---|---|---|
form_id | string | yes | Form ID. |
list_form_subscribers Read
List subscribers who signed up to a specific form.
- Lua path
app.integrations.mailerlite.list_form_subscribers- Full name
mailerlite.mailerlite_list_form_subscribers
| Parameter | Type | Required | Description |
|---|---|---|---|
form_id | string | yes | Form ID. |
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
list_webhooks Read
List configured webhooks.
- Lua path
app.integrations.mailerlite.list_webhooks- Full name
mailerlite.mailerlite_list_webhooks
| Parameter | Type | Required | Description |
|---|---|---|---|
page | integer | no | Page number. |
limit | integer | no | Maximum rows to return. |
get_webhook Read
Get a webhook by ID.
- Lua path
app.integrations.mailerlite.get_webhook- Full name
mailerlite.mailerlite_get_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | Webhook ID. |
create_webhook Write
Create a webhook subscription for subscriber or campaign events.
- Lua path
app.integrations.mailerlite.create_webhook- Full name
mailerlite.mailerlite_create_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | no | Webhook name. |
events | array | yes | Webhook event names. |
url | string | yes | Webhook callback URL. |
enabled | boolean | no | Whether the webhook is enabled. |
batchable | boolean | no | Required for campaign.open, campaign.click, and subscriber.deleted events. |
payload | object | no | Full webhook payload. |
update_webhook Write
Update webhook name, events, callback URL, enabled state, or batchable flag.
- Lua path
app.integrations.mailerlite.update_webhook- Full name
mailerlite.mailerlite_update_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | Webhook ID. |
name | string | no | Webhook name. |
events | array | no | Webhook event names. |
url | string | no | Webhook callback URL. |
enabled | boolean | no | Whether the webhook is enabled. |
batchable | boolean | no | Batchable flag. |
payload | object | no | Full webhook update payload. |
delete_webhook Write
Delete a webhook by ID.
- Lua path
app.integrations.mailerlite.delete_webhook- Full name
mailerlite.mailerlite_delete_webhook
| Parameter | Type | Required | Description |
|---|---|---|---|
webhook_id | string | yes | Webhook ID. |
batch_requests Write
Execute up to 50 MailerLite API requests in one batch. Paths must be relative API paths such as api/fields.
- Lua path
app.integrations.mailerlite.batch_requests- Full name
mailerlite.mailerlite_batch
| Parameter | Type | Required | Description |
|---|---|---|---|
requests | array | yes | Array of objects with method, path, and optional body. |
verify_credentials Read
Verify MailerLite credentials with a lightweight subscriber summary request.
- Lua path
app.integrations.mailerlite.verify_credentials- Full name
mailerlite.mailerlite_get_current_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
api_get Read
Call a relative MailerLite API path with GET for endpoints not yet wrapped by a dedicated tool.
- Lua path
app.integrations.mailerlite.api_get- Full name
mailerlite.mailerlite_api_get
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative API path, for example /subscribers. Absolute URLs are rejected. |
params | object | no | Query parameters. |
api_post Write
Call a relative MailerLite API path with POST for endpoints not yet wrapped by a dedicated tool.
- Lua path
app.integrations.mailerlite.api_post- Full name
mailerlite.mailerlite_api_post
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative API path. Absolute URLs are rejected. |
payload | object | no | JSON body. |
api_put Write
Call a relative MailerLite API path with PUT for endpoints not yet wrapped by a dedicated tool.
- Lua path
app.integrations.mailerlite.api_put- Full name
mailerlite.mailerlite_api_put
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative API path. Absolute URLs are rejected. |
payload | object | no | JSON body. |
api_patch Write
Call a relative MailerLite API path with PATCH for endpoints not yet wrapped by a dedicated tool.
- Lua path
app.integrations.mailerlite.api_patch- Full name
mailerlite.mailerlite_api_patch
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative API path. Absolute URLs are rejected. |
payload | object | no | JSON body. |
api_delete Write
Call a relative MailerLite API path with DELETE for endpoints not yet wrapped by a dedicated tool.
- Lua path
app.integrations.mailerlite.api_delete- Full name
mailerlite.mailerlite_api_delete
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | yes | Relative API path. Absolute URLs are rejected. |
payload | object | no | JSON body. |