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

The node interacts with the SparkBot WhatsApp API, specifically allowing management of WhatsApp groups. The "Revoke Invite Code" operation under the "Groups" resource enables users to invalidate an existing invite code for a specified WhatsApp group. This is useful when you want to prevent further users from joining a group via a previously shared invite link, enhancing group security and control.

Practical scenarios include:

Revoking access after an event or campaign ends.
Preventing unauthorized users from joining a private group.
Managing group membership dynamically by controlling invite codes.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the group is managed.
Group ID	The unique identifier of the WhatsApp group whose invite code will be revoked.

Output

The node outputs a JSON object representing the result of the revoke invite code operation. Typically, this includes confirmation that the invite code was successfully revoked or details about the updated group state. The exact structure depends on the API response but generally confirms the action's success.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot WhatsApp API service being accessible.
Proper configuration of the WhatsApp number (device) and group identifiers is necessary.
The node uses internal methods to load available devices and groups dynamically.

Troubleshooting

Common issues:
- Invalid or expired API key leading to authentication errors.
- Incorrect WhatsApp number or group ID causing "not found" errors.
- Network connectivity problems preventing API calls.
Error messages:
- Errors indicating missing or invalid parameters suggest checking the input properties.
- Permission-related errors may require verifying that the WhatsApp number has rights to manage the group.
Resolutions:
- Ensure the API key is valid and has required permissions.
- Verify that the WhatsApp number and group ID are correct and active.
- Check network settings and API endpoint accessibility.

Links and References

SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if known)
n8n documentation on creating custom nodes and using credentials: https://docs.n8n.io/
WhatsApp Group Management best practices: https://faq.whatsapp.com/

This summary focuses on the "Groups" resource and the "Revoke Invite Code" operation as requested.

SparkBotInstall