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
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
Files Actions
- Search Files
- Upload File
- Delete Files
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
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

Groups → Leave Group

AI-generated

Overview

This node allows users to interact with WhatsApp groups via the SparkBot WhatsApp API. Specifically, the "Leave Group" operation under the "Groups" resource enables a WhatsApp number (device) to leave a specified group. This is useful for automating group management tasks such as removing a bot or user from a group when certain conditions are met.

Practical examples:

Automatically leaving a group after completing a campaign or event.
Removing a WhatsApp number from inactive or irrelevant groups to keep the chat list clean.
Managing group memberships programmatically in workflows that involve multiple WhatsApp numbers.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) that will leave the group.
Group ID to Leave	The ID of the group that the WhatsApp number should leave.
Remove from Chat List	Boolean option indicating whether to remove the group from the chat list after leaving it.

Output

The node outputs JSON data representing the result of the leave group operation. This typically includes confirmation details about the action performed, such as success status or any returned metadata from the API.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot API endpoints related to group management.
Proper configuration of WhatsApp numbers (devices) and groups within the SparkBot system is necessary.
The node uses dynamic loading methods to fetch available devices and groups for selection.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID or group ID can cause failures.
- Attempting to leave a group that the device is not a member of may result in errors.
- Network or authentication errors if the API key is invalid or expired.
Error messages:
- Errors returned by the API will be included in the output JSON if "Continue On Fail" is enabled.
- Typical error messages might include "Group not found," "Device not authorized," or "Failed to leave group."
Resolutions:
- Verify that the WhatsApp number and group IDs are correct and that the device is currently a member of the group.
- Ensure the API key credential is valid and has the necessary permissions.
- Check network connectivity and API endpoint availability.

Links and References

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

If you need further details on other operations or resources, feel free to ask!

SparkBotInstall