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 integrates with the SparkBot WhatsApp API to manage WhatsApp chats. Specifically, the "Unassign Chat" operation under the "Chats" resource allows users to unassign a chat from an agent or user. This is useful in scenarios where a chat needs to be released from an assigned agent for reassignment, closure, or other workflow purposes.

Practical examples include:

Automatically unassigning a chat when a support ticket is closed.
Releasing chats from agents who are going offline or unavailable.
Managing workload distribution by unassigning chats before reassigning them to other agents.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the chat originates.
Chat ID	The unique identifier of the chat to unassign. Examples: `447362053576@c.us` for a user chat, `44736205357600000000@g.us` for a group chat.

Output

The output JSON contains the response from the SparkBot API after attempting to unassign the specified chat. It typically includes confirmation of the unassignment or details about the updated chat status.

If the operation fails and "Continue On Fail" is enabled, the output will contain an error object with a message describing the failure.

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 being accessible and properly configured.
The "WhatsApp Number" must be registered and active within the SparkBot system.
Proper permissions to modify chat assignments are necessary.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp Number or Chat ID parameters.
- Insufficient permissions to unassign chats.
- Network or authentication errors connecting to the SparkBot API.
- Attempting to unassign a chat that is not currently assigned.
Error Messages:
- "error": "Chat not found" — Verify the Chat ID is correct and exists.
- "error": "Unauthorized" — Check API key validity and permissions.
- "error": "Invalid device" — Confirm the WhatsApp Number is valid and active.
Resolutions:
- Double-check input parameters for correctness.
- Ensure the API key credential is correctly set up and has required scopes.
- Verify network connectivity and API endpoint availability.
- Use the node's "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

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

SparkBotInstall