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 enables managing WhatsApp chat contacts specifically by blocking selected contacts associated with a given WhatsApp number. It is useful in scenarios where you want to prevent certain phone numbers from interacting with your WhatsApp business account, for example, to block spam or unwanted users.

A practical example would be a customer support system that automatically blocks contacts who repeatedly send abusive messages or violate terms of service.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which you want to block contacts.
Contact Phone Numbers	One or more phone numbers (1 to 50) in international E164 format to be blocked from contacting.

Output

The node outputs JSON data representing the result of the block contacts operation. This typically includes confirmation of which contacts were successfully blocked or any error information if the operation failed.

No binary data output is involved.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the external SparkBot WhatsApp API service to perform contact blocking.
Proper configuration of the WhatsApp number (device) and valid phone numbers in E164 format are necessary.

Troubleshooting

Invalid Phone Number Format: Ensure all contact phone numbers are in correct E164 format (e.g., +1234567890). Incorrect formatting will cause errors.
API Authentication Errors: Verify that the API key credential is correctly set up and has sufficient permissions.
Device Not Found: The specified WhatsApp number (device) must exist and be active; otherwise, the operation will fail.
Exceeding Contact Limits: The node supports blocking up to 50 contacts at once. Sending more than this limit may cause errors.
Network Issues: Connectivity problems with the SparkBot API can cause timeouts or failures.

Links and References

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

SparkBotInstall