ZuckZapGo Newsletter icon

ZuckZapGo Newsletter

Manage WhatsApp newsletters/channels using ZuckZapGo API

Overview

This node integrates with the ZuckZapGo API to manage WhatsApp newsletters (channels). It allows users to perform a variety of newsletter-related operations such as listing newsletters, creating new ones, subscribing or unsubscribing, sending messages, reacting to messages, muting notifications, and more. This node is useful for automating interactions with WhatsApp newsletters, enabling marketing teams, community managers, or developers to programmatically control newsletter subscriptions and communications.

Practical examples include:

  • Automatically subscribing users to a newsletter based on external triggers.
  • Sending scheduled or event-driven messages to a newsletter audience.
  • Retrieving newsletter messages for analysis or archiving.
  • Managing newsletter settings like muting notifications or accepting terms of service.

Properties

Name Meaning
Newsletter JID The unique identifier (JID) of the newsletter to operate on.
Operation The action to perform, options include: List Newsletters, Create Newsletter, Get Info, Subscribe, Unsubscribe, Send Message, Mute, React, Mark Viewed, etc.
Newsletter Name Name of the newsletter when creating a new one (max 25 characters).
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 non-text messages (image, video, document, audio).
Caption Optional caption for media messages.
File Name Filename 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 (optional).
Server ID Server ID of the message to react to (required for reactions).
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 (optional).
After Server ID Get message updates after this server ID (optional).
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. The structure varies depending on the operation but generally includes details about newsletters, messages, subscription status, or confirmation of actions performed.

If the operation involves retrieving messages or message updates, the output contains arrays of message objects with metadata such as message IDs, content, timestamps, and sender information.

Binary data is not directly output by this node; media content is handled as base64 strings or URLs within the JSON payloads.

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

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect Newsletter JID or Invite Code may result in "not found" or "invalid code" errors.
    • Sending media messages requires valid base64 encoding or accessible URLs; invalid media inputs can cause request failures.
    • Required parameters missing for certain operations (e.g., message content for sending text messages) will trigger validation errors.
  • Error messages:

    • Errors returned from the API are passed through; typical messages include authorization errors, invalid parameters, or resource not found.
    • To resolve, verify all required fields are correctly set, ensure API credentials are valid, and confirm that referenced newsletters or messages exist.

Links and References

Discussion