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 manage chat contacts, specifically allowing users to unblock one or more WhatsApp contacts associated with a given WhatsApp number (device). It is useful in scenarios where certain contacts were previously blocked and need to be restored to normal communication status.

Practical examples include:

Customer support teams unblocking customers who were mistakenly blocked.
Marketing teams restoring communication with contacts after resolving issues.
Automating contact management workflows that require toggling block/unblock states on WhatsApp contacts.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the contacts will be unblocked.
Contact Phone Numbers	One or more phone numbers (1 to 50) in international E164 format representing contacts to unblock.

Output

The node outputs JSON data representing the result of the unblock operation for each contact. This typically includes confirmation of successful unblocking or error details if any contact could not be unblocked.

No binary data output is involved.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot WhatsApp API service being accessible.
The "WhatsApp Number" must be valid and linked to the authenticated account.
Proper configuration of the API key credential in n8n is necessary.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number/device ID can cause failures.
- Incorrectly formatted contact phone numbers (not in E164 format) may lead to errors.
- Exceeding the maximum allowed contacts (more than 50) will likely cause rejection.
- Network or authentication errors with the SparkBot API.
Error Messages:
- Errors related to invalid credentials usually indicate misconfigured or expired API keys.
- Validation errors on phone numbers suggest checking the format and ensuring country codes are included.
- Rate limiting or quota exceeded errors imply too many requests in a short time; consider adding delays or upgrading API plan.

Resolving these generally involves verifying input parameters, ensuring correct API key setup, and confirming network connectivity.

Links and References

E.164 Phone Number Format
SparkBot WhatsApp API documentation (refer to your provider's official docs for detailed API usage)

SparkBotInstall