SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node operation allows you to update participants in a WhatsApp group using the SparkBot WhatsApp API. It is useful for managing group membership dynamically, such as adding new members or changing participant roles (e.g., making someone an admin). Practical scenarios include automating group management for customer support teams, community groups, or event coordination where group membership changes frequently.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which the group is managed.
Group ID The unique identifier of the WhatsApp group to update participants in.
Participants List of participants to add or update in the group. Each participant includes:
- Phone Number: Participant's phone number in international format (e.g., +1234567890).
- Make Admin: Boolean flag indicating whether the participant should be granted admin privileges.

Output

The node outputs JSON data representing the result of the update participants operation. This typically includes confirmation of the updated participants and their roles within the group. The exact structure depends on the API response but generally contains details about the group and participant statuses after the update.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the SparkBot WhatsApp API.
  • Needs an API key credential configured in n8n for authentication with the SparkBot service.
  • The WhatsApp number (device) must be registered and linked to the SparkBot account.
  • The group must exist and be accessible by the specified WhatsApp number.

Troubleshooting

  • Common Issues:

    • Invalid or unregistered WhatsApp number/device ID.
    • Incorrect or expired API key leading to authentication failures.
    • Group ID not found or the bot does not have permission to modify the group.
    • Phone numbers of participants not in correct international format.
  • Error Messages:

    • "Group not found": Verify the Group ID is correct and the WhatsApp number has access.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is valid and properly configured.
    • "Invalid phone number format": Ensure all participant phone numbers use the international format starting with '+'.
  • Resolution Tips:

    • Double-check input parameters for correctness.
    • Confirm API credentials and permissions.
    • Validate phone numbers before passing them to the node.

Links and References

Discussion