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 update labels on a specific chat associated with a WhatsApp number. It allows users to manage chat labels by replacing all existing labels, adding/updating labels (upsert), or removing specified labels from a chat.

Common scenarios include:

Organizing chats by tagging them with relevant labels for easier filtering and management.
Updating chat metadata dynamically based on conversation context or workflow triggers.
Removing outdated or irrelevant labels to keep chat categorization accurate.

Practical example:

Automatically add a "Support" label to incoming chats routed to a support team.
Remove a "Pending" label once an issue is resolved in the chat.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number to which the chat belongs. This identifies the device/account.
Chat ID	The unique identifier of the chat to update labels on (e.g., user chat or group chat ID).
Labels	One or more labels to set on the chat.
Update Type	How to update the labels: - Replace All: Replace all existing labels with the provided ones. - Add/Update (Upsert): Add new labels or update existing ones. - Remove Only: Remove the specified labels only.

Output

The node outputs JSON data representing the result of the label update operation on the chat. This typically includes confirmation of the updated labels or status information returned by the SparkBot API.

No binary data output is involved.

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 (device) must be registered and active within the SparkBot system.

Troubleshooting

Invalid Chat ID: If the chat ID does not exist or is malformed, the API may return an error. Verify the chat ID format (e.g., 447362053576@c.us for user chats).
Unauthorized Access: Missing or invalid API key credentials will cause authentication failures. Ensure the API key is correctly configured in n8n credentials.
Labels Format Issues: Labels should be provided as strings; incorrect formatting or empty values might cause errors.
Update Type Misuse: Using "Remove Only" without specifying existing labels may have no effect. Confirm that labels to remove actually exist on the chat.
Device Not Found: The WhatsApp number (device) must be valid and loaded via the node's options. If the device is not found, the operation will fail.

Links and References

SparkBot WhatsApp API Documentation (generic link, replace with actual if available)
n8n documentation on Creating Custom Nodes
WhatsApp chat ID formats and usage guidelines (refer to WhatsApp Business API docs)

SparkBotInstall