# listmonk

> Run your listmonk newsletters: add, update, find, unsubscribe and delete subscribers, send transactional emails and campaigns, and start a workflow when someone subscribes or unsubscribes.

App · 17 actions. Web page: https://docs.lodol.com/docs/integrations/listmonk

## Actions

### Add or update subscriber

Add someone by email, such as from a sign-up form or a purchase, or update them if they're already there: add lists and attributes, keeping the rest.

**Inputs**

- Email (`email`, text, required): Their email address.
- Name (`name`, text): Their name. Leave blank to keep theirs, or for a new subscriber to take it from their email address.
- Lists (`lists`, list): Lists to subscribe them to. They stay on lists they're already on, and stay unsubscribed from any they left.
- Attributes (`attributes`, object): Extra details to keep on them, such as city: Leeds or plan: pro. Added to theirs, replacing any with the same name.
- Confirmed (`confirmed`, true/false): Turn on only if the person has already agreed to hear from you: their subscriptions are confirmed without emailing them. Off, listmonk emails a confirmation link for a double opt-in list.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created` (true/false): True if they were added, false if they were already there
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created": true,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```

### Add to lists

Subscribe someone to lists, including one they unsubscribed from. Lists they're already confirmed on are left as they are.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.
- Lists (`lists`, list, required): The lists to add them to.
- Confirmed (`confirmed`, true/false): Turn on only if the person has already agreed to hear from you: their subscriptions are confirmed without emailing them. Off, listmonk emails a confirmation link for a double opt-in list.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```

### Blocklist subscriber

Blocklist someone: unsubscribe them from every list so listmonk never emails them again. Undo it in listmonk.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```

### Create campaign

Make a campaign (a newsletter) for lists, as a draft to send or schedule with Send campaign.

**Inputs**

- Subject (`subject`, text, required): The email's subject line.
- Lists (`lists`, list, required): The lists to send it to.
- Body (`body`, text, required): What the email says, written in the format you pick.
- Format (`body_format`, text): What the body is written in. One of: `markdown`, `html`, `richtext` (Rich text), `plain` (Plain text). Default: `markdown`.
- Name (`name`, text): Its name in listmonk. Leave blank to use the subject.
- Template (`template`, text): The design it's sent in. Leave blank for listmonk's default.
- From (`from_email`, text): Who it's from, such as Acme <news@acme.example>. Leave blank for listmonk's default.
- Tags (`tags`, list): Tags to file it under.

**Outputs**

- `bounces` (number): How many emails bounced
- `clicks` (number): How many times links in it were clicked
- `created_at` (text): When it was made (ISO 8601)
- `format` (text): What the body is written in: markdown, html, richtext or plain
- `from_email` (text): Who it's from
- `id` (number): The campaign's ID
- `link` (text): A link to it in listmonk
- `list_ids` (list): The IDs of the lists it goes to
- `lists` (list): The names of the lists it goes to
- `name` (text): Its name in listmonk
- `send_at` (text): When it's scheduled to send (ISO 8601); empty if not
- `sent` (number): How many it has been sent to
- `started_at` (text): When it started sending (ISO 8601); empty if not yet
- `status` (text): draft, scheduled, running, paused, cancelled or finished
- `subject` (text): Its subject line
- `tags` (list): Its tags
- `template_id` (number): The template it's sent in
- `to_send` (number): How many subscribers it's going to
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): Its UUID
- `views` (number): How many times it was opened

**Example output**

```json
{
  "bounces": 3,
  "clicks": 140,
  "created_at": "2026-11-04T16:20:00Z",
  "format": "markdown",
  "from_email": "Acme <news@acme.example>",
  "id": 27,
  "link": "https://lists.example.com/admin/campaigns/27",
  "list_ids": [
    3
  ],
  "lists": [
    "Weekly newsletter"
  ],
  "name": "November newsletter",
  "send_at": "",
  "sent": 0,
  "started_at": "2026-11-05T10:00:02Z",
  "status": "draft",
  "subject": "What's new in November",
  "tags": [
    "monthly"
  ],
  "template_id": 1,
  "to_send": 0,
  "updated_at": "2026-11-05T10:04:41Z",
  "uuid": "e07db486-0d3d-4aba-b27f-e282cb5c92f8",
  "views": 612
}
```

### Create list

Make a mailing list, such as one for an event's attendees.

**Inputs**

- Name (`name`, text, required): What to call it.
- Type (`list_type`, text): Public lists show on listmonk's sign-up page; private ones don't. One of: `private`, `public`. Default: `private`.
- Opt-in (`optin`, text): Double opt-in emails new subscribers a link to confirm first. One of: `single` (Single opt-in), `double` (Double opt-in). Default: `single`.
- Description (`description`, text): What the list is for.
- Tags (`tags`, list): Tags to file it under.

**Outputs**

- `created_at` (text): When it was made (ISO 8601)
- `description` (text): Its description
- `id` (number): The list's ID
- `link` (text): A link to it in listmonk
- `name` (text): Its name
- `optin` (text): single, or double: new subscribers confirm by email
- `status` (text): active or archived
- `subscriber_count` (number): How many subscribers it has
- `tags` (list): Its tags
- `type` (text): public (on the sign-up page) or private
- `uuid` (text): Its UUID

**Example output**

```json
{
  "created_at": "2026-01-14T10:00:00Z",
  "description": "Our weekly round-up",
  "id": 3,
  "link": "https://lists.example.com/admin/lists/3",
  "name": "Weekly newsletter",
  "optin": "double",
  "status": "active",
  "subscriber_count": 0,
  "tags": [
    "newsletter"
  ],
  "type": "public",
  "uuid": "732f9e89-4c1c-4d95-8cf3-f45d9fa957df"
}
```

### Delete campaign

Delete a campaign that isn't sending, with its statistics. It can't be undone.

**Inputs**

- Campaign (`campaign`, text, required): The campaign: pick it, or give its ID or link.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (number): Its ID
- `name` (text): Its name

**Example output**

```json
{
  "deleted": true,
  "id": 27,
  "name": "November newsletter"
}
```

### Delete list

Delete a mailing list. Its subscribers stay in listmonk, off that list.

**Inputs**

- List (`list_id`, text, required): The list to delete.

**Outputs**

- `deleted` (true/false): True once deleted
- `id` (number): Its ID
- `name` (text): Its name

**Example output**

```json
{
  "deleted": true,
  "id": 3,
  "name": "Weekly newsletter"
}
```

### Delete subscriber

Delete someone and everything listmonk holds about them, such as for a request to erase their data. It can't be undone.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.

**Outputs**

- `deleted` (true/false): True once deleted
- `email` (text): Their email address
- `id` (number): The deleted subscriber's ID

**Example output**

```json
{
  "deleted": true,
  "email": "jane@example.com",
  "id": 1042
}
```

### Find subscribers

Find subscribers on a list, by their status there, by words in their name or email, or with listmonk's advanced query. Newest first unless you pick another order.

**Inputs**

- List (`list_id`, text): Only subscribers on this list.
- Status on the list (`subscription_status`, text): Only those with this status on the list. Needs a list. One of: `confirmed`, `unconfirmed`, `unsubscribed`.
- Words (`search`, text): Only those with these words in their name or email address.
- Advanced query (`query`, text): A condition as listmonk's Advanced search on its Subscribers page takes it, such as subscribers.attribs->>'city' = 'Leeds' or subscribers.created_at > '2026-01-01'.
- Order (`sort`, text): Which come first. One of: `newest` (Newest first), `oldest` (Oldest first), `updated` (Most recently updated), `name` (By name). Default: `newest`.
- How many (`limit`, number): The most to list. Defaults to 25. From 1 to 100.

**Outputs**

- `count` (number): How many are listed
- `subscribers` (list): The subscribers found
- `total` (number): How many match in all

**Example output**

```json
{
  "count": 1,
  "subscribers": [
    {
      "attributes": {
        "city": "Leeds",
        "plan": "pro"
      },
      "blocklisted": false,
      "created_at": "2026-11-05T09:12:44Z",
      "email": "jane@example.com",
      "id": 1042,
      "link": "https://lists.example.com/admin/subscribers/1042",
      "list_names": [
        "Weekly newsletter"
      ],
      "lists": [
        {
          "id": 3,
          "name": "Weekly newsletter",
          "optin": "double",
          "subscribed_at": "2026-11-05T09:12:44Z",
          "subscription_status": "confirmed"
        }
      ],
      "name": "Jane Doe",
      "status": "enabled",
      "updated_at": "2026-11-05T09:12:44Z",
      "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
    }
  ],
  "total": 1
}
```

### Get campaign

Get a campaign's status and how it did: how many it was sent to, views, clicks and bounces.

**Inputs**

- Campaign (`campaign`, text, required): The campaign: pick it, or give its ID or link.

**Outputs**

- `bounces` (number): How many emails bounced
- `clicks` (number): How many times links in it were clicked
- `created_at` (text): When it was made (ISO 8601)
- `format` (text): What the body is written in: markdown, html, richtext or plain
- `from_email` (text): Who it's from
- `id` (number): The campaign's ID
- `link` (text): A link to it in listmonk
- `list_ids` (list): The IDs of the lists it goes to
- `lists` (list): The names of the lists it goes to
- `name` (text): Its name in listmonk
- `send_at` (text): When it's scheduled to send (ISO 8601); empty if not
- `sent` (number): How many it has been sent to
- `started_at` (text): When it started sending (ISO 8601); empty if not yet
- `status` (text): draft, scheduled, running, paused, cancelled or finished
- `subject` (text): Its subject line
- `tags` (list): Its tags
- `template_id` (number): The template it's sent in
- `to_send` (number): How many subscribers it's going to
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): Its UUID
- `views` (number): How many times it was opened

**Example output**

```json
{
  "bounces": 3,
  "clicks": 140,
  "created_at": "2026-11-04T16:20:00Z",
  "format": "markdown",
  "from_email": "Acme <news@acme.example>",
  "id": 27,
  "link": "https://lists.example.com/admin/campaigns/27",
  "list_ids": [
    3
  ],
  "lists": [
    "Weekly newsletter"
  ],
  "name": "November newsletter",
  "send_at": "",
  "sent": 1250,
  "started_at": "2026-11-05T10:00:02Z",
  "status": "finished",
  "subject": "What's new in November",
  "tags": [
    "monthly"
  ],
  "template_id": 1,
  "to_send": 1250,
  "updated_at": "2026-11-05T10:04:41Z",
  "uuid": "e07db486-0d3d-4aba-b27f-e282cb5c92f8",
  "views": 612
}
```

### Get subscriber

Look someone up by email address or ID: their lists, status there and attributes. Says if they aren't found rather than failing.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `found` (true/false): Whether listmonk has them; the other fields are empty if not
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "found": true,
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```

### List lists

List every mailing list, with whether it's public and how many subscribers it has.

**Inputs**: None.

**Outputs**

- `count` (number): How many
- `lists` (list): The lists, by name

**Example output**

```json
{
  "count": 1,
  "lists": [
    {
      "created_at": "2026-01-14T10:00:00Z",
      "description": "Our weekly round-up",
      "id": 3,
      "link": "https://lists.example.com/admin/lists/3",
      "name": "Weekly newsletter",
      "optin": "double",
      "status": "active",
      "subscriber_count": 1250,
      "tags": [
        "newsletter"
      ],
      "type": "public",
      "uuid": "732f9e89-4c1c-4d95-8cf3-f45d9fa957df"
    }
  ]
}
```

### List templates

List the email templates: campaign designs and transactional emails.

**Inputs**

- Kind (`template_type`, text): Only templates of this kind. Leave blank for all. One of: `tx` (Transactional), `campaign`.

**Outputs**

- `count` (number): How many
- `templates` (list): The templates

**Example output**

```json
{
  "count": 1,
  "templates": [
    {
      "id": 5,
      "is_default": false,
      "name": "Order receipt",
      "subject": "Your order {{ .Tx.Data.order_id }}",
      "type": "tx"
    }
  ]
}
```

### Remove from lists

Take someone off lists altogether, leaving no record they were on them. To respect a request to stop emails, use Unsubscribe from lists.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.
- Lists (`lists`, list, required): The lists to take them off.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```

### Send campaign

Start sending a draft campaign to its lists now, or schedule it for a time. A scheduled one can be sent now or moved to a new time.

**Inputs**

- Campaign (`campaign`, text, required): The campaign: pick it, or give its ID or link.
- Send at (`send_at`, date and time): When to send it. Leave blank to send it now.

**Outputs**

- `bounces` (number): How many emails bounced
- `clicks` (number): How many times links in it were clicked
- `created_at` (text): When it was made (ISO 8601)
- `format` (text): What the body is written in: markdown, html, richtext or plain
- `from_email` (text): Who it's from
- `id` (number): The campaign's ID
- `link` (text): A link to it in listmonk
- `list_ids` (list): The IDs of the lists it goes to
- `lists` (list): The names of the lists it goes to
- `name` (text): Its name in listmonk
- `send_at` (text): When it's scheduled to send (ISO 8601); empty if not
- `sent` (number): How many it has been sent to
- `started_at` (text): When it started sending (ISO 8601); empty if not yet
- `status` (text): draft, scheduled, running, paused, cancelled or finished
- `subject` (text): Its subject line
- `tags` (list): Its tags
- `template_id` (number): The template it's sent in
- `to_send` (number): How many subscribers it's going to
- `updated_at` (text): When it last changed (ISO 8601)
- `uuid` (text): Its UUID
- `views` (number): How many times it was opened

**Example output**

```json
{
  "bounces": 3,
  "clicks": 140,
  "created_at": "2026-11-04T16:20:00Z",
  "format": "markdown",
  "from_email": "Acme <news@acme.example>",
  "id": 27,
  "link": "https://lists.example.com/admin/campaigns/27",
  "list_ids": [
    3
  ],
  "lists": [
    "Weekly newsletter"
  ],
  "name": "November newsletter",
  "send_at": "",
  "sent": 0,
  "started_at": "2026-11-05T10:00:02Z",
  "status": "running",
  "subject": "What's new in November",
  "tags": [
    "monthly"
  ],
  "template_id": 1,
  "to_send": 1250,
  "updated_at": "2026-11-05T10:04:41Z",
  "uuid": "e07db486-0d3d-4aba-b27f-e282cb5c92f8",
  "views": 612
}
```

### Send transactional email

Send one person an email from a transactional template, such as a receipt or a welcome, filled in with details you give.

**Inputs**

- Template (`template`, text, required): The transactional template to send.
- To (`to`, text, required): The subscriber's email address or ID.
- Details (`data`, object): Details for the template, such as order_id: A1042. The template shows one as {{ .Tx.Data.order_id }}.
- Subject (`subject`, text): A subject line. Leave blank for the template's own.
- From (`from_email`, text): Who it's from, such as Acme <hello@acme.example>. Leave blank for listmonk's default.
- Send to non-subscribers (`send_to_non_subscribers`, true/false): Also send it when the address isn't a subscriber in listmonk. Off, an address listmonk doesn't have fails the step.

**Outputs**

- `sent` (true/false): True once listmonk has taken the email to send
- `subject` (text): The subject given; empty when the template's own was used
- `template` (text): The template's name
- `template_id` (number): The template's ID
- `to` (text): Who it went to: their email address, or ID

**Example output**

```json
{
  "sent": true,
  "subject": "",
  "template": "Order receipt",
  "template_id": 5,
  "to": "jane@example.com"
}
```

### Unsubscribe from lists

Mark someone unsubscribed from lists, as an unsubscribe link does, so campaigns to those lists no longer reach them.

**Inputs**

- Subscriber (`subscriber`, text, required): Their email address or subscriber ID.
- Lists (`lists`, list, required): The lists to unsubscribe them from.

**Outputs**

- `attributes` (object): Their attributes: extra details such as city or plan
- `blocklisted` (true/false): Whether they're blocklisted, so never emailed
- `created_at` (text): When they were added (ISO 8601)
- `email` (text): Their email address
- `id` (number): The subscriber's ID
- `link` (text): A link to them in listmonk
- `list_names` (list): The lists they're subscribed to (not unsubscribed from)
- `lists` (list): Every list they're on, with their status there
- `name` (text): Their name
- `status` (text): enabled, or blocklisted
- `updated_at` (text): When their details last changed (ISO 8601)
- `uuid` (text): Their UUID, as in their unsubscribe links

**Example output**

```json
{
  "attributes": {
    "city": "Leeds",
    "plan": "pro"
  },
  "blocklisted": false,
  "created_at": "2026-11-05T09:12:44Z",
  "email": "jane@example.com",
  "id": 1042,
  "link": "https://lists.example.com/admin/subscribers/1042",
  "list_names": [
    "Weekly newsletter"
  ],
  "lists": [
    {
      "id": 3,
      "name": "Weekly newsletter",
      "optin": "double",
      "subscribed_at": "2026-11-05T09:12:44Z",
      "subscription_status": "confirmed"
    }
  ],
  "name": "Jane Doe",
  "status": "enabled",
  "updated_at": "2026-11-05T09:12:44Z",
  "uuid": "5099bf60-995f-4270-8a22-cd6a9a9ad3fc"
}
```
