ZuckZapGo Newsletter icon

ZuckZapGo Newsletter

Manage WhatsApp newsletters/channels using ZuckZapGo API
Join our community

Actions15

Overview

This node integrates with the ZuckZapGo API to manage WhatsApp newsletters (also called channels). It allows users to perform a variety of newsletter-related operations such as listing newsletters, creating new ones, retrieving information about specific newsletters, subscribing or unsubscribing, sending messages and reactions, muting notifications, and more.

Common scenarios where this node is beneficial include:

  • Automating newsletter management workflows for WhatsApp channels.
  • Sending broadcast messages or media to subscribers.
  • Managing subscriptions and user interactions programmatically.
  • Tracking and reacting to newsletter message updates.
  • Handling administrative tasks like inviting admins or accepting terms of service.

For example, a marketing team could use this node to automatically send promotional content to their WhatsApp newsletter subscribers or to gather analytics on subscriber engagement.

Properties

Name Meaning
Operation The action to perform. Options include: List Newsletters, Create Newsletter, Get Newsletter Info, Get Subscribed Newsletters, Send Newsletter Message, Subscribe Newsletter, Subscribe with Invite, Unsubscribe Newsletter, Unsubscribe with Invite, Mute Newsletter, Get Newsletter Messages, Send Newsletter Reaction, Mark Newsletter Viewed, Subscribe Live Updates, Get Message Updates, Accept TOS Notice, Send Admin Invite.
Newsletter JID The unique identifier (JID) of the newsletter/channel, e.g., "120363025246943103@newsletter". Required for many operations involving a specific newsletter.
Newsletter Name Name of the newsletter (max 25 characters). Used when creating a newsletter or sending admin invites.
Description Optional description text for the newsletter when creating it.
Picture Optional base64 encoded image or URL for the newsletter picture when creating it.
Invite Code Code used to subscribe or unsubscribe via invite.
Message Type Type of message to send: Text, Image, Video, Document, Audio.
Message Text content of the message (required if Message Type is Text).
Media Base64 encoded media or URL for media messages (Image, Video, Document, Audio).
Caption Optional caption for media messages.
File Name File name for document messages.
Mute Boolean to mute or unmute newsletter notifications.
Count Number of messages to retrieve or updates to fetch.
Before Message ID Retrieve messages before this server message ID.
Server ID Server ID of the message to react to.
Reaction Emoji reaction to send to a newsletter message.
Server IDs Comma-separated list of server message IDs to mark as viewed.
Since Timestamp Unix timestamp to get message updates since that time.
After Server ID Get message updates after this server ID.
Notice ID Notice ID for accepting terms of service (default provided).
Stage Stage number for terms of service acceptance (default provided).
Phone Number Phone number to send an admin invite to.
Invite Image Base64 encoded image or URL for the admin invite.
Invite Caption Caption text for the admin invite.
Invite Name Name of the newsletter for the admin invite.

Output

The node outputs JSON data corresponding to the response from the ZuckZapGo API for the selected operation. This typically includes details about newsletters, messages, subscription status, or confirmation of actions performed.

  • For message retrieval operations, the output contains arrays of newsletter messages with metadata.
  • For info or list operations, the output contains newsletter details.
  • For sending messages or reactions, the output confirms success or returns error details.
  • When marking messages viewed or muting newsletters, the output confirms the action.
  • No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the ZuckZapGo API.
  • The node makes HTTP requests to the ZuckZapGo API endpoints.
  • Proper configuration of the API credential in n8n is necessary for successful operation.

Troubleshooting

  • Invalid or missing Newsletter JID: Many operations require a valid newsletter JID. Ensure the JID is correctly specified.
  • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Incorrect message type or missing media: When sending media messages, ensure the media field is properly set with base64 or URL and that required fields like file name for documents are provided.
  • Malformed server IDs: For operations requiring server IDs (e.g., marking viewed), ensure IDs are comma-separated integers without extra spaces.
  • Handling rate limits or API errors: If the API returns errors, check the error message returned in the output JSON for guidance.
  • Use the "Continue On Fail" option to handle errors gracefully within workflows.

Links and References

Discussion