Actions71
- Settings Actions
- Subscribers Actions
- Create Subscriber
- Manage Subscriber Lists By Query
- Get Subscribers
- Delete Subscriber By List
- Get Subscriber By Id
- Update Subscriber By Id
- Delete Subscriber By Id
- Manage Subscriber Lists
- Manage Subscriber List By Id
- Manage Blocklist By Subscriber List
- Manage Blocklist Subscribers By Id
- Export Subscriber Data By ID
- Get Subscriber Bounces By Id
- Delete Subscriber Bounces By Id
- Subscriber Send Optin By Id
- Delete Subscriber By Query
- Blocklist Subscribers Query
- Bounces Actions
- Import Actions
- Campaigns Actions
- Update Preview Campaign By Id
- Get Campaigns
- Create Campaign
- Get Campaign By Id
- Update Campaign By Id
- Delete Campaign By Id
- Get Running Campaign Stats
- Get Campaign Analytics
- Preview Campaign By Id
- Preview Campaign Text By Id
- Update Campaign Status By Id
- Update Campaign Archive By Id
- Create Campaign Content By Id
- Test Campaign By Id
- Media Actions
- Templates Actions
- Public Actions
- Miscellaneous Actions
- Admin Actions
- Logs Actions
- Lists Actions
- Transactional Actions
- Maintenance Actions
Overview
This node updates the settings of a Listmonk application via its API. It allows users to modify various configuration options such as application site name, URLs, email settings, privacy preferences, upload provider details, bounce handling, appearance customization, and more. This node is useful for automating the management and customization of Listmonk settings programmatically, for example, updating branding elements, email configurations, or privacy settings in bulk or as part of a deployment pipeline.
Use Case Examples
- Updating the app site name and root URL to reflect a new branding.
- Changing email notification settings and enabling/disabling public subscription pages.
- Configuring upload provider details such as S3 bucket information.
- Adjusting privacy settings like individual tracking and unsubscribe header options.
Properties
| Name | Meaning |
|---|---|
| App Site Name | The name of the application site, used for branding and display. |
| App Root Url | The root URL of the application, defining the base address for the site. |
| App Logo Url | URL to the logo image used in the application interface. |
| App Favicon Url | URL to the favicon image displayed in browser tabs. |
| App From Email | The email address used as the sender for outgoing emails. |
| App Notify Emails | List of email addresses to notify for certain events or alerts. |
| App Enable Public Subscription Page | Boolean flag to enable or disable the public subscription page. |
| App Enable Public Archive | Boolean flag to enable or disable the public archive of messages. |
| App Send Optin Confirmation | Boolean flag to send confirmation emails for opt-in subscriptions. |
| App Check Updates | Boolean flag to enable or disable automatic update checks. |
| App Lang | Language setting for the application interface. |
| App Batch Size | Number of items to process per batch for sending or processing. |
| App Concurrency | Number of concurrent operations allowed. |
| App Max Send Errors | Maximum number of send errors allowed before stopping. |
| App Message Rate | Rate limit for sending messages. |
| App Message Sliding Window | Boolean flag to enable or disable sliding window rate limiting. |
| App Message Sliding Window Duration | Duration for the sliding window rate limiting. |
| App Message Sliding Window Rate | Rate limit within the sliding window duration. |
| Privacy Individual Tracking | Boolean flag to enable or disable individual user tracking. |
| Privacy Unsubscribe Header | Boolean flag to include or exclude unsubscribe header in emails. |
| Privacy Allow Blocklist | Boolean flag to allow or disallow blocklisting of users. |
| Privacy Allow Preferences | Boolean flag to allow or disallow user preferences management. |
| Privacy Allow Export | Boolean flag to allow or disallow data export. |
| Privacy Allow Wipe | Boolean flag to allow or disallow data wiping. |
| Privacy Exportable | List of data fields or types that are exportable. |
| Privacy Domain Blocklist | List of domains that are blocklisted for privacy reasons. |
| Upload Provider | The upload service provider used for file storage. |
| Upload Filesystem Upload Path | Filesystem path where uploads are stored. |
| Upload Filesystem Upload Uri | URI for accessing uploaded files on the filesystem. |
| Upload S 3 Url | URL endpoint for the S3 upload service. |
| Upload S 3 Public Url | Public URL for accessing S3 uploaded files. |
| Upload S 3 Aws Access Key Id | AWS access key ID for S3 authentication. |
| Upload S 3 Aws Default Region | AWS region for the S3 bucket. |
| Upload S 3 Bucket | Name of the S3 bucket used for uploads. |
| Upload S 3 Bucket Domain | Domain associated with the S3 bucket. |
| Upload S 3 Bucket Path | Path within the S3 bucket for uploads. |
| Upload S 3 Bucket Type | Type of S3 bucket (e.g., standard, infrequent access). |
| Upload S 3 Expiry | Expiry time for S3 signed URLs. |
| Smtp | SMTP configuration details for sending emails. |
| Messengers | Configuration for messenger integrations. |
| Bounce Enabled | Boolean flag to enable or disable bounce handling. |
| Bounce Webhooks Enabled | Boolean flag to enable or disable bounce webhooks. |
| Bounce Count | Number of bounce attempts allowed. |
| Bounce Action | Action to take on bounce events. |
| Bounce Ses Enabled | Boolean flag to enable or disable Amazon SES bounce handling. |
| Bounce Sendgrid Enabled | Boolean flag to enable or disable SendGrid bounce handling. |
| Bounce Sendgrid Key | API key for SendGrid bounce handling. |
| Bounce Forwardemail Enabled | Boolean flag to enable or disable Forwardemail bounce handling. |
| Bounce Forwardemail Key | API key for Forwardemail bounce handling. |
| Bounce Postmark Enabled | Boolean flag to enable or disable Postmark bounce handling. |
| Bounce Postmark Username | Username for Postmark bounce handling. |
| Bounce Postmark Password | Password for Postmark bounce handling. |
| Bounce Mailboxes | List of mailboxes configured for bounce handling. |
| Appearance Admin Custom Css | Custom CSS for the admin interface appearance. |
| Appearance Admin Custom Js | Custom JavaScript for the admin interface appearance. |
| Appearance Public Custom Css | Custom CSS for the public interface appearance. |
| Appearance Public Custom Js | Custom JavaScript for the public interface appearance. |
| Request Options | Options for HTTP request behavior such as batching, SSL handling, proxy, and timeout. |
Output
JSON
success- Indicates if the settings update was successfulmessage- Response message from the API after updating settingsupdatedSettings- The settings data that was updated
Dependencies
- Listmonk API
Troubleshooting
- Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
- Validate JSON input fields to prevent parsing errors when sending complex settings like notify emails or SMTP configurations.
- Check network connectivity and proxy settings if requests time out or fail.
- Verify that boolean and number fields are correctly formatted to avoid API validation errors.
Links
- Listmonk API Documentation - Official API documentation for Listmonk, useful for understanding available endpoints and settings.