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 chat contacts, specifically allowing deletion of a contact from a WhatsApp number's contact list. It is useful in scenarios where you need to programmatically remove outdated or unwanted contacts from your WhatsApp business account managed via SparkBot.

Practical examples include:

Automatically cleaning up contacts who have unsubscribed or are no longer relevant.
Managing contact lists dynamically based on CRM or marketing automation workflows.
Ensuring compliance by removing contacts upon user request.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the contact will be deleted.
Contact ID	The unique identifier of the contact to delete (e.g., `447362053576@c.us`).

Output

The node outputs a JSON object representing the result of the delete operation. Typically, this will confirm whether the contact was successfully deleted or provide an error message if the operation failed.

No binary data output is expected from this operation.

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" must be valid and associated with the authenticated account.
The "Contact ID" must correspond to an existing contact in the specified WhatsApp number.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp Number or Contact ID parameters.
- Authentication failures due to incorrect or expired API keys.
- Attempting to delete a contact that does not exist or is already deleted.
- Network connectivity issues preventing access to the SparkBot API.
Error messages and resolutions:
- "Contact not found": Verify the Contact ID is correct and exists under the specified WhatsApp Number.
- "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set and has necessary permissions.
- "Invalid WhatsApp Number": Confirm the device ID corresponds to a valid WhatsApp number linked to your account.
- Timeout or network errors: Ensure stable internet connection and that the SparkBot API endpoint is reachable.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation on Creating Custom Nodes
WhatsApp Business API guidelines for contact management (consult official WhatsApp resources)

SparkBotInstall