SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node operation allows you to add participants to a WhatsApp group using the SparkBot WhatsApp API. It is useful for automating group management tasks such as inviting new members or promoting them to admins within WhatsApp groups managed by your WhatsApp number(s). Practical examples include:

  • Automatically adding customers or team members to specific WhatsApp groups based on workflow triggers.
  • Managing event or community groups by programmatically adding participants and optionally granting admin privileges.
  • Integrating with CRM or support systems to keep WhatsApp groups updated with relevant contacts.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which the group operation will be performed.
Group ID The unique identifier of the WhatsApp group where participants will be added.
Participants A collection of participants to add, each with:
- Phone Number: The participant's phone number in international format (e.g., +1234567890).
- Make Admin: Boolean flag indicating whether the participant should be granted admin rights.

Output

The node outputs JSON data representing the result of the add participants operation. This typically includes confirmation details about the participants added and their status in the group. There is no binary output.

Dependencies

  • Requires an active connection to the SparkBot WhatsApp API via an API key credential.
  • The node depends on dynamic loading of WhatsApp numbers (devices) and groups associated with those devices.
  • Proper permissions and valid group IDs are necessary to successfully add participants.

Troubleshooting

  • Common Issues:

    • Invalid or missing WhatsApp number/device ID can cause failures.
    • Incorrect or expired group ID will prevent adding participants.
    • Phone numbers not in international format may be rejected.
    • Lack of admin privileges on the WhatsApp number to modify the group.
  • Error Messages:

    • Errors related to authentication usually indicate invalid or missing API credentials.
    • "Group not found" or similar errors suggest incorrect group ID or device mismatch.
    • Validation errors on participant phone numbers require checking the format and correctness.
  • Resolutions:

    • Verify API key and ensure it has required permissions.
    • Confirm that the WhatsApp number and group ID are correct and accessible.
    • Ensure phone numbers are formatted with the country code and "+" prefix.
    • Check that the WhatsApp number used has admin rights in the target group.

Links and References

Discussion