Actions33
- Public Actions
- Public Admin Actions
- Reseller Actions
- Create New Team
- Get Team Information
- Update Team
- Remove Team From Reseller
- Update Team Avatar
- Create Team Bulk Inboxes And Users
- Get Team Users
- Add User To Team
- Remove Users From Team
- Get Team Inboxes
- Remove Team Inboxes
- Create Team Bulk Inboxes
- Assign Users To Inbox
- Remove Users From Inbox
- Get Team Whitelist Domains
- Create Team Whitelisted Domain
- Remove Team Whitelisted Domain
- Create Reseller
- Import Team Users
- Get Import Team Users Job Status
Overview
This node operation "Create And Trigger Campaign" under the "Public" resource is designed to create and immediately send a messaging campaign to a specified contact list. It allows users to define the sender, target list, message content, media attachments, and additional optional parameters such as the messaging provider or campaign name.
Common scenarios where this node would be beneficial include:
- Marketing teams sending promotional campaigns with images or videos to segmented subscriber lists.
- Customer engagement workflows that trigger timely notifications or reminders to groups of contacts.
- Automated outreach for events, sales, or announcements using multimedia messages.
For example, a user could set up a campaign to send a sale reminder with an image to all premium subscribers, specifying the sender phone number and choosing WhatsApp as the provider.
Properties
| Name | Meaning |
|---|---|
| Sender | The phone number or identifier from which campaign messages will be sent. |
| List Name | The name of the contact list to which the campaign messages will be sent. |
| Media Urls | JSON array of URLs pointing to media files (images, videos) to include in the campaign messages. |
| Body | The text content of the campaign message. |
| Additional Body Fields | Optional extra fields for the campaign: |
| - Provider | Messaging provider to send the message from. Options: twilio, bandwidth, msteams, other, non_voip, whatsapp, telnyx, webex, rcs |
| - Name | An optional name for the campaign (e.g., "Sale Reminder"). |
Output
The node outputs JSON data representing the result of the campaign creation and triggering process. This typically includes information about the campaign status, identifiers, and any response details from the messaging service API.
If the node supports binary data output (not indicated explicitly here), it would represent media or message delivery receipts, but based on the provided code and properties, the primary output is structured JSON reflecting the campaign operation outcome.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard ClerkChat service.
- Depends on the external AvantGuard ClerkChat API endpoint configured via node credentials.
- Uses HTTP requests with JSON payloads to interact with the messaging backend.
- No other external services or environment variables are explicitly required beyond the API authentication.
Troubleshooting
- Invalid Sender or List Name: If the sender number or list name is incorrect or not found, the API may return errors indicating invalid parameters. Verify these values before running the node.
- Malformed Media URLs: Ensure that the media URLs are valid and accessible. Invalid URLs or unsupported media types can cause campaign creation failures.
- Provider Mismatch: Selecting an unsupported or misconfigured provider option may lead to message sending errors. Confirm the provider matches your account capabilities.
- API Authentication Errors: Missing or invalid API credentials will prevent the node from successfully creating or triggering campaigns. Check that the API key is correctly set up in n8n credentials.
- JSON Parsing Issues: The
mediaUrlsproperty expects a JSON array string; malformed JSON input will cause parsing errors. Use proper JSON formatting.
Links and References
- AvantGuard ClerkChat API Documentation (example placeholder link)
- n8n Custom Node Development Guide
- JSON Syntax Guide