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 numbers and their associated chats. Specifically, the Delete Chats operation under the WhatsApp Numbers resource allows users to delete chat histories for specified phone numbers linked to a particular WhatsApp number ID (device). This is useful for cleaning up or managing chat data programmatically.

Common scenarios:

Automatically clearing chat histories for specific contacts after a campaign or customer interaction.
Managing storage by deleting old or irrelevant chats from selected WhatsApp numbers.
Maintaining privacy compliance by removing chat data on demand.

Practical example:
You have a WhatsApp number connected to your business account and want to delete chats with up to 10 specific customers identified by their international phone numbers. Using this node, you specify the WhatsApp number ID and provide the list of phone numbers whose chats should be deleted.

Properties

Name	Meaning
WhatsApp Number ID	The unique identifier of the WhatsApp number (device) from which chats will be deleted.
Chat Phone Numbers	One to ten phone numbers (with international country codes) whose chats will be deleted.

Output

The node outputs JSON data representing the result of the delete chats operation. Typically, this will include confirmation of successful deletion or details about any errors encountered during the process.

If the operation supports binary data output (not indicated here), it would represent related files or media, but in this case, the output is purely JSON-based.

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 internal methods that handle various resources and operations, including the executeNumberOperations method for the WhatsApp Numbers resource.

Troubleshooting

Common issues:
- Providing invalid or non-existent WhatsApp Number IDs may cause failures.
- Incorrectly formatted phone numbers (missing country code or invalid characters) can lead to errors.
- Exceeding the maximum allowed phone numbers (more than 10) will likely cause validation errors.
- Network or authentication issues with the SparkBot API can prevent successful execution.
Error messages:
- Errors related to missing required parameters indicate that either the WhatsApp Number ID or phone numbers were not provided.
- Authentication errors suggest problems with the API key credential setup.
- API response errors might include rate limits or permission denials; resolving these requires checking API usage policies and credentials.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API guidelines for chat management

Note: This summary is based solely on static analysis of the provided source code and property definitions without runtime execution or access to external documentation.

SparkBotInstall