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 chat statuses for WhatsApp numbers. Specifically, the "Set Chat Status" operation allows users to update the internal status of a particular chat associated with a WhatsApp number. This is useful in customer support or sales scenarios where chats need to be tracked by their lifecycle stage, such as marking conversations as active, pending, resolved, archived, or removed.

Practical examples include:

Marking a customer support chat as "resolved" after the issue is addressed.
Archiving old chats to keep the active chat list clean.
Setting a chat to "pending" when awaiting customer response.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the chat belongs. Loaded dynamically via available devices.
Chat ID	The unique identifier of the chat to update. Examples: `447362053576@c.us` for individual user chats, `44736205357600000000@g.us` for group chats.
Status	The new internal status to assign to the chat. Options are: Active, Pending, Resolved, Archived, Removed.

Output

The node outputs a JSON object representing the result of the status update operation. This typically includes confirmation details about the updated chat status. The exact structure depends on the SparkBot API response but generally confirms success or provides error information.

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 service being accessible and properly configured.
The "WhatsApp Number" property dynamically loads available devices via an internal method, so the user must have at least one registered WhatsApp number/device linked to their account.

Troubleshooting

Common issues:
- Invalid or missing Chat ID: Ensure the Chat ID is correctly formatted and corresponds to an existing chat.
- Unauthorized errors: Verify that the API key credential is valid and has sufficient permissions.
- Network or API downtime: Check connectivity and SparkBot service status.
Error messages:
- "Chat not found": The specified Chat ID does not exist or is not accessible under the given WhatsApp number.
- "Invalid status value": The status provided is not one of the allowed options.
- "Authentication failed": The API key credential is invalid or expired.

Resolving these usually involves verifying input parameters, refreshing credentials, and ensuring the SparkBot API is operational.

Links and References

SparkBot WhatsApp API Documentation (example link, replace with actual)
n8n documentation on Creating Custom Nodes
WhatsApp Business API general info: https://www.whatsapp.com/business/api

SparkBotInstall