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

The "Reject Members" operation under the "Groups" resource allows users to reject pending membership requests in a WhatsApp group managed via the SparkBot WhatsApp API. This node is useful for administrators who want to control group membership by selectively rejecting certain phone numbers or rejecting all pending members at once.

Practical scenarios include:

Automatically rejecting spam or unauthorized join requests to a WhatsApp group.
Managing group membership approvals programmatically based on custom criteria.
Bulk rejecting all pending members when cleaning up group membership requests.

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 where members are to be rejected.
Approve All	Boolean flag indicating whether to reject all pending members in the group.
Phone Numbers	List of phone numbers to reject from the pending members list (used only if "Approve All" is false).

Output

The node outputs JSON data representing the result of the reject members operation. Typically, this will include confirmation of which members were rejected or an error message if the operation failed.

No binary data output is expected from 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 node depends on dynamic loading of WhatsApp devices and groups for selection in properties.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number (device) ID can cause failures in identifying the correct source device.
- Incorrect or expired group ID may lead to errors when attempting to reject members.
- Providing phone numbers that are not pending members might result in no action or errors.
- Network or authentication issues with the SparkBot API can prevent successful execution.
Error Messages:
- Errors related to authorization typically indicate problems with the API key credential; verify and update as needed.
- "Group not found" or similar messages suggest the group ID is invalid or the device does not have access to it.
- Validation errors on phone numbers usually mean the format is incorrect or the numbers are not pending members.

To resolve these, ensure all IDs and phone numbers are correct, the API key is valid, and the device has access to the specified group.

Links and References

SparkBot WhatsApp API Documentation
WhatsApp Group Management Best Practices
n8n Documentation on Creating Custom Nodes

SparkBotInstall