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 the read/unread status of a specific chat on a given WhatsApp number. It allows users to mark chats as either read or unread programmatically.

Common scenarios where this node is beneficial:

Automatically marking chats as read after processing messages in a workflow.
Flagging important chats as unread to remind agents or users to follow up.
Synchronizing chat read statuses between external systems and WhatsApp.

Practical example:

A customer support automation workflow could use this node to mark a chat as read once a ticket is created, ensuring that agents know which conversations have been handled.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the chat belongs. This is selected from available WhatsApp numbers linked to the account.
Chat ID	The unique identifier of the chat to update. Examples include `447362053576@c.us` for individual users or `44736205357600000000@g.us` for groups.
Unread Status	Boolean flag indicating whether to mark the chat as unread (`true`) or read (`false`).

Output

The node outputs a JSON object representing the result of the update operation. This typically includes confirmation details about the chat whose read status was updated.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API via an API key credential.
The node depends on the availability of WhatsApp numbers (devices) configured in the SparkBot system.
Proper permissions to modify chat statuses on the specified WhatsApp number are necessary.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number/device ID may cause failures.
- Incorrect or malformed Chat ID can lead to errors or no effect.
- Insufficient permissions or expired API keys will prevent successful updates.
Error messages and resolutions:
- "Chat not found" — Verify the Chat ID is correct and exists on the specified WhatsApp number.
- "Unauthorized" or "Authentication failed" — Check that the API key credential is valid and has required permissions.
- "Invalid device" — Ensure the WhatsApp number selected is properly registered and active in the SparkBot system.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes
WhatsApp Business API official docs for understanding chat identifiers and statuses: https://developers.facebook.com/docs/whatsapp/api/messages

SparkBotInstall