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 users to join WhatsApp groups via the SparkBot WhatsApp API integration. It supports joining a group either by providing an invite code or an invite URL. This functionality is useful for automating group membership management, such as adding a WhatsApp number to specific groups for broadcasting messages, customer support, or community engagement.

Practical examples:

Automatically joining a customer support group when onboarding a new WhatsApp number.
Adding marketing numbers to promotional groups using invite URLs.
Managing multiple WhatsApp devices and their group memberships programmatically.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) that will join the group.
Join Method	Method to join the group; options are: - Invite Code - Invite URL
Invite Code	The group invitation code used to join the group (required if Join Method is "Invite Code")
Invite URL	The full group invitation URL (e.g., https://chat.whatsapp.com/XXXXXXX) (required if Join Method is "Invite URL")

Output

The node outputs JSON data representing the result of the join group operation. This typically includes confirmation details from the API about the success or failure of joining the group. The exact structure depends on the API response but generally confirms the group joined or provides error information.

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 with the SparkBot service.
The node relies on dynamically loaded WhatsApp device IDs ("WhatsApp Number") which must be available via the node's load options method.

Troubleshooting

Common issues:
- Providing an invalid or expired invite code or URL will cause the join operation to fail.
- Using a WhatsApp number/device ID that is not registered or authorized may result in authentication errors.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Errors returned from the API usually include descriptive messages indicating why joining failed (e.g., "Invalid invite code", "Device not found").
- If the node throws an error related to missing parameters, ensure that the correct join method is selected and the corresponding invite code or URL is provided.
Resolutions:
- Verify the invite code or URL is current and valid.
- Confirm the WhatsApp number/device is correctly set up and authenticated.
- Check API key credentials and network access.
- Enable "Continue On Fail" in the node settings to handle errors gracefully during batch operations.

Links and References

WhatsApp Group Invitation Links
SparkBot WhatsApp API documentation (refer to your API provider’s official docs for detailed usage)

SparkBotInstall