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 team-related operations, specifically granting a user access to a WhatsApp device (number). The "Grant Device Access" operation allows administrators or managers to assign permissions for a specific team member to use or manage a particular WhatsApp number within the organization.

Common scenarios:

Assigning a new support agent access to a shared WhatsApp business number.
Managing user permissions dynamically as team roles change.
Automating onboarding processes by programmatically granting device access.

Practical example:
An admin wants to grant a newly hired customer service representative access to the company's main WhatsApp number so they can respond to customer inquiries. Using this node, the admin selects the WhatsApp number and the user ID of the representative, then executes the operation to grant access without manual intervention in the SparkBot dashboard.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) to which access will be granted.
User ID	The ID of the user (team member) who will be granted access to the selected WhatsApp number.

WhatsApp Number is selected from available devices via a dynamic dropdown.
User ID depends on the selected WhatsApp Number and lists team agents eligible for access.

Output

The node outputs JSON data representing the result of the grant access operation. This typically includes confirmation details such as success status, updated user-device access information, or error messages if the operation fails.

No binary data output is involved in this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n for authentication.
Dynamic loading of options for WhatsApp numbers and team users depends on API calls to SparkBot.

Troubleshooting

Common issues:
- Selecting a WhatsApp number or user ID that does not exist or is invalid.
- Insufficient permissions in the API key to modify team access.
- Network or authentication errors when connecting to the SparkBot API.
Error messages:
- Errors returned from the API will be included in the output JSON under an error field if "Continue On Fail" is enabled.
- Typical errors include "User not found," "Device not found," or "Access denied."
Resolutions:
- Verify that the WhatsApp number and user IDs are correct and currently active.
- Ensure the API key has the necessary permissions for team management.
- Check network connectivity and API endpoint availability.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n documentation on Creating Custom Nodes

SparkBotInstall