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

The node interacts with the SparkBot WhatsApp API to update chat attributes for a specified WhatsApp number and chat. This operation is useful when you want to programmatically modify chat settings such as pinning or muting a chat within a WhatsApp account managed by SparkBot.

Practical examples include:

Automatically pinning important customer support chats to keep them easily accessible.
Muting less critical group chats during off-hours to reduce notifications.
Managing chat states in bulk based on business logic or user preferences.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) on which the chat exists.
Chat ID	The unique identifier of the chat to update (e.g., `447362053576@c.us` for a user chat or `44736205357600000000@g.us` for a group chat).
Attributes	Collection of chat attributes to update:
	- Pinned: Boolean to pin (`true`) or unpin (`false`) the chat.
	- Muted: Boolean to mute (`true`) or unmute (`false`) the chat.

Output

The node outputs JSON data representing the result of the update operation. This typically includes confirmation of the updated attributes or any relevant metadata returned by the SparkBot API about the chat after modification.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n for authenticating requests to SparkBot.
The node depends on internal methods that handle chat operations via the SparkBot API.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number (device) ID can cause failures.
- Incorrect chat ID format may lead to errors or no updates applied.
- Insufficient permissions or expired API keys will prevent successful updates.
Error messages:
- Errors related to authentication usually indicate problems with the API key credential; verify and update it if necessary.
- "Chat not found" or similar errors suggest the chat ID does not exist or is inaccessible under the given WhatsApp number.
To resolve, ensure all input properties are correctly set, and the API key has proper access rights.

Links and References

SparkBot WhatsApp API Documentation (for detailed API capabilities and chat management)
n8n documentation on creating custom nodes

SparkBotInstall