Listmonk icon

Listmonk

Interact with a listmonk instance for email marketing and newsletter management. Supports creating subscribers, managing campaigns, sending emails, and more.

Actions32

Setting → Update Settings

AI-generated

Overview

This node integrates with a listmonk instance, an email marketing and newsletter management platform. Specifically, the "Update Settings" operation under the "Setting" resource allows users to update various configuration settings of their listmonk server. This is useful for administrators who want to programmatically modify site details, email sending parameters, privacy options, upload configurations, SMTP settings, bounce handling, appearance customizations, and more.

Practical examples include:

  • Changing the site name or root URL after a rebranding.
  • Updating SMTP server credentials or connection limits.
  • Enabling or disabling public subscription pages or archives.
  • Adjusting privacy-related settings such as unsubscribe headers or data export permissions.
  • Configuring file upload providers and paths.
  • Customizing admin or public interface CSS/JS.

Properties

Name Meaning
Settings (JSON) A JSON object containing the settings to update on the listmonk instance. The JSON supports a wide range of configuration keys including:
- app.site_name, app.root_url, app.logo_url, app.favicon_url, app.from_email, app.notify_emails (array of strings), app.enable_public_subscription_page (boolean), app.enable_public_archive (boolean), app.send_optin_confirmation (boolean), app.check_updates (boolean), app.lang (string), app.batch_size (number), app.concurrency (number), app.max_send_errors (number), app.message_rate (number), app.message_sliding_window (boolean), app.message_sliding_window_duration (string), app.message_sliding_window_rate (number)
- Privacy settings like privacy.individual_tracking (boolean), privacy.unsubscribe_header (boolean), privacy.allow_blocklist (boolean), privacy.allow_preferences (boolean), privacy.allow_export (boolean), privacy.allow_wipe (boolean), privacy.exportable (array of strings), privacy.domain_blocklist (array of objects)
- Upload provider and related settings for filesystem or S3 storage including URLs, paths, access keys, regions, bucket info, expiry, etc.
- SMTP server configurations as an array of objects with fields like uuid, enabled, host, port, auth_protocol, username, email_headers, max_conns, max_msg_retries, idle_timeout, wait_timeout, tls_type, tls_skip_verify
- Messenger configurations (array of objects)
- Bounce handling settings including enabling flags, webhook settings, counts, actions, and integration keys for SES, SendGrid, Postmark, plus mailbox configurations
- Appearance customization for admin and public interfaces via custom CSS and JS strings.

Output

The node outputs the response from the listmonk API after attempting to update the settings. The output is structured as JSON and typically contains confirmation of the updated settings or error information if the update failed.

If the node supports binary data output, it is not indicated in the provided code or properties, so the output is purely JSON-based.

Dependencies

  • Requires connection to a listmonk instance's API endpoint.
  • Needs an API authentication credential consisting of a domain URL, username, and password.
  • The base URL for requests is constructed by trimming trailing slashes from the domain credential and appending /api.
  • Requests use HTTP Basic Authentication with the provided username and password.
  • The node expects the listmonk API to accept and respond with JSON content.

Troubleshooting

  • Common Issues:

    • Invalid or incomplete JSON in the "Settings (JSON)" property can cause request failures.
    • Incorrect API credentials or domain URL will result in authentication errors.
    • Trying to update unsupported or malformed settings keys may lead to API errors.
    • Network connectivity issues between n8n and the listmonk server can cause timeouts or connection errors.

  • Error Messages:

    • Authentication errors typically indicate invalid username/password or missing credentials.
    • Validation errors from the API may specify which setting keys or values are incorrect.
    • Connection refused or timeout errors suggest network or server availability problems.

  • Resolutions:

    • Validate the JSON syntax before running the node.
    • Verify API credentials and domain URL correctness.
    • Consult listmonk API documentation for valid settings keys and value types.
    • Ensure the listmonk server is reachable from the n8n environment.

Links and References

Discussion