SparkBot

Interact with SparkBot WhatsApp API

Actions148

Chats Actions
- Archive Chat
- Unarchive Chat
- Delete Chat
- Bulk Update Chats
- Get Chats
- Get Chat Details
- Send Typing Status
- Sync Device Chats
- Sync Chat Messages
- Update Chat Read Status
- Set Chat Status
- Get Group Participants
- Assign Chat
- Unassign Chat
- Create Chat Note
- Delete Chat Note
- Update Chat Labels
- Update Chat Attributes
Chat Contacts Actions
- Get Contacts
- Get Contact Details
- Create Contact
- Update Contact
- Update Contact Metadata
- Upsert Contact Metadata
- Delete Contact
- Bulk Create Contacts
- Block Contacts
- Unblock Contacts
Chat Messages Actions
- Get Messages
- Get Message Details
- Get Message Delivery Info
- Edit Message
- Delete Message
Chat Files Actions
- Get Files
- Get File Details
- Download File
Files Actions
- Delete Files
- Search Files
- Upload File
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
Team Actions
- Get Team Members
- Update Team Member
- Delete Team Members
- Get Device Team Members
- Create Team Member
- Grant Device Access
- Revoke Device Access
Labels Actions
- Get Labels
- Create Label
- Update Label
- Delete Label
Departments Actions
- Get Departments
- Create Department
- Update Department
- Delete Department
Quick replies Actions
- Get Quick Replies
- Create Quick Reply
- Update Quick Reply
- Delete Quick Replies
Queue Actions
- Get Queue Status
- Set Queue Status
- Route Queue
- Empty Queue
WhatsApp session Actions
- Sync session
- Start session
- Scan QR
- Reset session
- Reboot session
- Get session health
- Request Authentication Code
WhatsApp profile Actions
- Get Profile
- Update Profile
- Get Profile Image
- Update Profile Image
Business catalog Actions
- Get My Catalog
- Query Business Catalog
Campaigns Actions
- Get Campaigns
- Get Campaign
- Update Campaign Status
- Get Campaign Contacts
- Delete Campaign
Meeting Links Actions
- Get Meeting Links
- Create Meeting Link
- Delete Meeting Links
User Status Actions
- Get User Status
- Get User Status by ID
- Update User Status
- Delete User Status
Webhooks Actions
- Get Webhooks
- Create Webhook
- Get Webhook
- Update Webhook
- Delete Webhook
- Enable Webhook
- Get Webhook Logs
Other Actions
- Verify number exists
- Validate phone numbers
- Send API request
Send messages Actions
- Send text message
- Send multimedia message
- Send scheduled message
- Send poll message
- Send votes in a poll
- Delete votes in a poll
- Send meeting event
- Send meeting confirmation
- Send location
- Send contacts
- Send reaction
- Send catalog product
- Forward message
Outbound Messages Actions
- Search Messages
- Get Message
- Update Message
- Delete Message
WhatsApp Numbers Actions
- Get Numbers
- Get Number by ID
- Create Number
- Update Number
- Delete Number
- Delete Chats
Groups Actions
- Get Groups
- Get Group
- Create Group
- Update Group
- Update Group Image
- Add Participants
- Update Participants
- Remove Participants
- Get Pending Members
- Approve Members
- Reject Members
- Get Invite Code
- Revoke Invite Code
- Join Group
- Leave Group
Channels Actions
- Get Channels
- Get Channel
- Create Channel
- Update Channel
- Update Channel Image
- Delete Channel
- Join Channel
- Search Channels

Overview

This node interacts with the SparkBot WhatsApp API to manage WhatsApp groups. Specifically, the "Remove Participants" operation under the "Groups" resource allows users to remove one or more participants from a specified WhatsApp group. This is useful for managing group membership dynamically, such as moderating group members, removing inactive users, or cleaning up groups.

Practical examples include:

Removing users who have left an organization from internal WhatsApp groups.
Moderating community groups by removing participants who violate rules.
Automating group membership management in customer support or sales teams.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) used to perform the operation.
Group ID	The unique identifier of the WhatsApp group from which participants will be removed.
Phone Numbers	One or more phone numbers (in international format, e.g., +1234567890) representing participants to remove from the group.

Output

The node outputs JSON data representing the result of the removal operation. Typically, this includes confirmation of the participants removed or any relevant status information returned by the SparkBot API.

If the operation involves binary data (not indicated here), it would represent files or media related to the group or participants, but this operation focuses on participant removal and thus outputs JSON only.

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 node depends on dynamic loading of options for WhatsApp numbers ("devices") and groups, which requires proper API access and permissions.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number (device) ID can cause failures.
- Incorrect or non-existent Group ID will prevent participant removal.
- Phone numbers not formatted correctly (e.g., missing country code) may lead to errors.
- Insufficient permissions or expired API keys can block the operation.
Error Messages:
- Errors indicating "Group not found" suggest the Group ID is incorrect or the device does not have access to that group.
- "Participant not in group" means one or more phone numbers are not members of the specified group.
- Authentication errors indicate issues with the API key credential setup.
Resolutions:
- Verify the WhatsApp number and group IDs using the node's option loaders before running the operation.
- Ensure phone numbers are in the correct international format.
- Check API key validity and permissions.
- Use the node's "continue on fail" option to handle partial failures gracefully.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
WhatsApp Group Management Best Practices
n8n Documentation on Creating Custom Nodes

SparkBotInstall