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 operation allows users to test a specific campaign by its ID within the Listmonk platform. It is useful for previewing or validating campaign content and settings before sending it out to recipients. Practical examples include verifying email campaigns, checking message formatting, and ensuring the correct audience lists are targeted.
Use Case Examples
- Testing an email campaign by providing its ID and optionally modifying the subject, body, or recipient lists before sending a test message.
- Previewing a messenger campaign by specifying the campaign ID and adjusting the message content to see how it appears to recipients.
Properties
| Name | Meaning |
|---|---|
| Id | The unique identifier of the campaign to be tested. This is a required property to specify which campaign to test. |
| Name | The name of the campaign, used to identify or label the test campaign. |
| Subject | The subject line of the campaign message, typically used in email campaigns. |
| Body | The main content or message body of the campaign. |
| Body Source | The source format or raw content of the campaign body. |
| Lists | The recipient lists to which the campaign will be sent, specified in JSON format. |
| From Email | The email address from which the campaign is sent. |
| Content Type | The content type of the campaign message, such as text or HTML. |
| Messenger | The messenger platform or channel used for the campaign. |
| Type | The type or category of the campaign. |
| Tags | Tags associated with the campaign for categorization or filtering, specified in JSON format. |
| Send Later | A boolean flag indicating whether the campaign should be sent later (scheduled) or immediately. |
| Send At | The scheduled time for sending the campaign, specified in JSON format. |
| Request Options | Additional request options such as batching, SSL certificate handling, proxy settings, and timeout configuration. |
Output
JSON
id- The ID of the tested campaign.status- The status or result of the test operation.message- Additional information or message returned from the test operation.
Dependencies
- Requires an API key credential for authenticating with the Listmonk API.
Troubleshooting
- Ensure the campaign ID provided exists and is valid to avoid errors related to missing campaigns.
- Check that the API credentials are correctly configured to prevent authentication failures.
- If using JSON input for lists or tags, ensure the JSON is properly formatted to avoid parsing errors.
- Timeouts may occur if the server is slow to respond; adjust the timeout setting in request options if needed.
Links
- Listmonk API Documentation - Official documentation for the Listmonk API which this node interacts with.