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 "Archive Chat" operation under the "Chats" resource allows users to archive a specific WhatsApp chat associated with a given WhatsApp number. Archiving a chat typically means marking it as archived in the WhatsApp system, which can help organize conversations by hiding them from the main chat list without deleting them.

This node operation is beneficial for automating chat management workflows, such as:

Automatically archiving chats after they are resolved or inactive.
Organizing chats programmatically based on custom business logic.
Integrating WhatsApp chat status updates into broader CRM or support systems.

For example, a customer support team could use this operation to archive chats once a ticket is closed, keeping their active chat list clean.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) to operate on. This identifies which WhatsApp account to use. Options are dynamically loaded from available devices.
Chat ID	The unique identifier of the chat to archive. Examples include user chats like `447362053576@c.us` or group chats like `44736205357600000000@g.us`.

Output

The output JSON contains the response from the API call that archives the specified chat. It typically includes confirmation details about the archived chat, such as its ID and status. The exact structure depends on the underlying API response but generally confirms successful archiving.

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 availability of registered WhatsApp numbers (devices) to select from.
Proper configuration of the API key credential within n8n is necessary for successful execution.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number (device) selection may cause failures.
- Incorrect or malformed Chat ID will result in errors from the API.
- Network or authentication issues with the SparkBot API can prevent archiving.
Error Messages:
- Errors related to authorization usually indicate problems with the API key credential; verify and update credentials as needed.
- "Chat not found" or similar messages suggest the provided Chat ID does not exist or is inaccessible for the selected device.
- Rate limiting or API quota exceeded errors require checking API usage limits.

Resolving these typically involves verifying input parameters, ensuring valid credentials, and confirming the chat exists on the specified WhatsApp number.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
WhatsApp Chat Identifiers Format (explains chat ID formats for users and groups)

SparkBotInstall