listmonk

App · 17 actions

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.

Actions

ActionWhat it does
Add or update subscriberAdd 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.
Add to listsSubscribe someone to lists, including one they unsubscribed from.
Blocklist subscriberBlocklist someone: unsubscribe them from every list so listmonk never emails them again.
Create campaignMake a campaign (a newsletter) for lists, as a draft to send or schedule with Send campaign.
Create listMake a mailing list, such as one for an event's attendees.
Delete campaignDelete a campaign that isn't sending, with its statistics.
Delete listDelete a mailing list.
Delete subscriberDelete someone and everything listmonk holds about them, such as for a request to erase their data.
Find subscribersFind subscribers on a list, by their status there, by words in their name or email, or with listmonk's advanced query.
Get campaignGet a campaign's status and how it did: how many it was sent to, views, clicks and bounces.
Get subscriberLook someone up by email address or ID: their lists, status there and attributes.
List listsList every mailing list, with whether it's public and how many subscribers it has.
List templatesList the email templates: campaign designs and transactional emails.
Remove from listsTake someone off lists altogether, leaving no record they were on them.
Send campaignStart sending a draft campaign to its lists now, or schedule it for a time.
Send transactional emailSend one person an email from a transactional template, such as a receipt or a welcome, filled in with details you give.
Unsubscribe from listsMark someone unsubscribed from lists, as an unsubscribe link does, so campaigns to those lists no longer reach them.

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

EmailemailtextRequired
Their email address.
Namenametext
Their name. Leave blank to keep theirs, or for a new subscriber to take it from their email address.
Listslistslist
Lists to subscribe them to. They stay on lists they're already on, and stay unsubscribed from any they left.
Attributesattributesobject
Extra details to keep on them, such as city: Leeds or plan: pro. Added to theirs, replacing any with the same name.
Confirmedconfirmedtrue/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

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
createdtrue/false
True if they were added, false if they were already there
created_attext
When they were added (ISO 8601)
emailtext
Their email address
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.
ListslistslistRequired
The lists to add them to.
Confirmedconfirmedtrue/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

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
created_attext
When they were added (ISO 8601)
emailtext
Their email address
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.

Outputs

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
created_attext
When they were added (ISO 8601)
emailtext
Their email address
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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

SubjectsubjecttextRequired
The email's subject line.
ListslistslistRequired
The lists to send it to.
BodybodytextRequired
What the email says, written in the format you pick.
Formatbody_formattext
What the body is written in.One of: markdown, html, richtext (Rich text), plain (Plain text). Default: markdown.
Namenametext
Its name in listmonk. Leave blank to use the subject.
Templatetemplatetext
The design it's sent in. Leave blank for listmonk's default.
Fromfrom_emailtext
Who it's from, such as Acme <news@acme.example>. Leave blank for listmonk's default.
Tagstagslist
Tags to file it under.

Outputs

bouncesnumber
How many emails bounced
clicksnumber
How many times links in it were clicked
created_attext
When it was made (ISO 8601)
formattext
What the body is written in: markdown, html, richtext or plain
from_emailtext
Who it's from
idnumber
The campaign's ID
linktext
A link to it in listmonk
list_idslist
The IDs of the lists it goes to
listslist
The names of the lists it goes to
nametext
Its name in listmonk
send_attext
When it's scheduled to send (ISO 8601); empty if not
sentnumber
How many it has been sent to
started_attext
When it started sending (ISO 8601); empty if not yet
statustext
draft, scheduled, running, paused, cancelled or finished
subjecttext
Its subject line
tagslist
Its tags
template_idnumber
The template it's sent in
to_sendnumber
How many subscribers it's going to
updated_attext
When it last changed (ISO 8601)
uuidtext
Its UUID
viewsnumber
How many times it was opened
Example output
{
  "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

NamenametextRequired
What to call it.
Typelist_typetext
Public lists show on listmonk's sign-up page; private ones don't.One of: private, public. Default: private.
Opt-inoptintext
Double opt-in emails new subscribers a link to confirm first.One of: single (Single opt-in), double (Double opt-in). Default: single.
Descriptiondescriptiontext
What the list is for.
Tagstagslist
Tags to file it under.

Outputs

created_attext
When it was made (ISO 8601)
descriptiontext
Its description
idnumber
The list's ID
linktext
A link to it in listmonk
nametext
Its name
optintext
single, or double: new subscribers confirm by email
statustext
active or archived
subscriber_countnumber
How many subscribers it has
tagslist
Its tags
typetext
public (on the sign-up page) or private
uuidtext
Its UUID
Example output
{
  "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

CampaigncampaigntextRequired
The campaign: pick it, or give its ID or link.

Outputs

deletedtrue/false
True once deleted
idnumber
Its ID
nametext
Its name
Example output
{
  "deleted": true,
  "id": 27,
  "name": "November newsletter"
}

Delete list

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

Inputs

Listlist_idtextRequired
The list to delete.

Outputs

deletedtrue/false
True once deleted
idnumber
Its ID
nametext
Its name
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.

Outputs

deletedtrue/false
True once deleted
emailtext
Their email address
idnumber
The deleted subscriber's ID
Example output
{
  "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

Listlist_idtext
Only subscribers on this list.
Status on the listsubscription_statustext
Only those with this status on the list. Needs a list.One of: confirmed, unconfirmed, unsubscribed.
Wordssearchtext
Only those with these words in their name or email address.
Advanced queryquerytext
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'.
Ordersorttext
Which come first.One of: newest (Newest first), oldest (Oldest first), updated (Most recently updated), name (By name). Default: newest.
How manylimitnumber
The most to list. Defaults to 25.From 1 to 100.

Outputs

countnumber
How many are listed
subscriberslist
The subscribers found
totalnumber
How many match in all
Example output
{
  "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

CampaigncampaigntextRequired
The campaign: pick it, or give its ID or link.

Outputs

bouncesnumber
How many emails bounced
clicksnumber
How many times links in it were clicked
created_attext
When it was made (ISO 8601)
formattext
What the body is written in: markdown, html, richtext or plain
from_emailtext
Who it's from
idnumber
The campaign's ID
linktext
A link to it in listmonk
list_idslist
The IDs of the lists it goes to
listslist
The names of the lists it goes to
nametext
Its name in listmonk
send_attext
When it's scheduled to send (ISO 8601); empty if not
sentnumber
How many it has been sent to
started_attext
When it started sending (ISO 8601); empty if not yet
statustext
draft, scheduled, running, paused, cancelled or finished
subjecttext
Its subject line
tagslist
Its tags
template_idnumber
The template it's sent in
to_sendnumber
How many subscribers it's going to
updated_attext
When it last changed (ISO 8601)
uuidtext
Its UUID
viewsnumber
How many times it was opened
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.

Outputs

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
created_attext
When they were added (ISO 8601)
emailtext
Their email address
foundtrue/false
Whether listmonk has them; the other fields are empty if not
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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

countnumber
How many
listslist
The lists, by name
Example output
{
  "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

Kindtemplate_typetext
Only templates of this kind. Leave blank for all.One of: tx (Transactional), campaign.

Outputs

countnumber
How many
templateslist
The templates
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.
ListslistslistRequired
The lists to take them off.

Outputs

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
created_attext
When they were added (ISO 8601)
emailtext
Their email address
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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

CampaigncampaigntextRequired
The campaign: pick it, or give its ID or link.
Send atsend_atdate and time
When to send it. Leave blank to send it now.

Outputs

bouncesnumber
How many emails bounced
clicksnumber
How many times links in it were clicked
created_attext
When it was made (ISO 8601)
formattext
What the body is written in: markdown, html, richtext or plain
from_emailtext
Who it's from
idnumber
The campaign's ID
linktext
A link to it in listmonk
list_idslist
The IDs of the lists it goes to
listslist
The names of the lists it goes to
nametext
Its name in listmonk
send_attext
When it's scheduled to send (ISO 8601); empty if not
sentnumber
How many it has been sent to
started_attext
When it started sending (ISO 8601); empty if not yet
statustext
draft, scheduled, running, paused, cancelled or finished
subjecttext
Its subject line
tagslist
Its tags
template_idnumber
The template it's sent in
to_sendnumber
How many subscribers it's going to
updated_attext
When it last changed (ISO 8601)
uuidtext
Its UUID
viewsnumber
How many times it was opened
Example output
{
  "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

TemplatetemplatetextRequired
The transactional template to send.
TototextRequired
The subscriber's email address or ID.
Detailsdataobject
Details for the template, such as order_id: A1042. The template shows one as {{ .Tx.Data.order_id }}.
Subjectsubjecttext
A subject line. Leave blank for the template's own.
Fromfrom_emailtext
Who it's from, such as Acme <hello@acme.example>. Leave blank for listmonk's default.
Send to non-subscriberssend_to_non_subscriberstrue/false
Also send it when the address isn't a subscriber in listmonk. Off, an address listmonk doesn't have fails the step.

Outputs

senttrue/false
True once listmonk has taken the email to send
subjecttext
The subject given; empty when the template's own was used
templatetext
The template's name
template_idnumber
The template's ID
totext
Who it went to: their email address, or ID
Example output
{
  "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

SubscribersubscribertextRequired
Their email address or subscriber ID.
ListslistslistRequired
The lists to unsubscribe them from.

Outputs

attributesobject
Their attributes: extra details such as city or plan
blocklistedtrue/false
Whether they're blocklisted, so never emailed
created_attext
When they were added (ISO 8601)
emailtext
Their email address
idnumber
The subscriber's ID
linktext
A link to them in listmonk
list_nameslist
The lists they're subscribed to (not unsubscribed from)
listslist
Every list they're on, with their status there
nametext
Their name
statustext
enabled, or blocklisted
updated_attext
When their details last changed (ISO 8601)
uuidtext
Their UUID, as in their unsubscribe links
Example output
{
  "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"
}

On this page