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 update an existing quick reply associated with a WhatsApp number. Quick replies are predefined message templates that can be triggered by shortcut keywords, enabling faster and consistent responses in WhatsApp conversations.

Typical use cases include:

Updating the content or shortcut keyword of a quick reply to reflect new information.
Changing access permissions for who can use or edit the quick reply.
Attaching media files to enrich quick replies with images, videos, or documents.
Managing keywords associated with quick replies to improve searchability or categorization.

For example, a customer support team might update a quick reply shortcut "hours" to provide updated business hours or attach a PDF brochure as a media file.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number where the quick reply belongs.
Shortcut	Shortcut keyword (2-25 characters) used to trigger the quick reply.
Message	The text content of the quick reply (4-6000 characters).
Permission	Access level for the quick reply: Public, Read-only, or Private.
Include Media File	Boolean flag indicating whether to attach a media file to the quick reply.
File ID	ID of a previously uploaded media file to attach (required if including a media file).
Keywords	Optional list of up to 3 alphanumeric keywords to associate with the quick reply.
Quick Reply ID	The unique identifier of the quick reply to update (24 character hex string).

Output

The node outputs JSON data representing the result of the update operation on the quick reply. This typically includes details such as the updated quick reply's ID, shortcut, message content, permissions, attached media file info (if any), and associated keywords.

If a media file is included, the output reflects the attachment but does not output binary data directly.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the SparkBot service being accessible and properly configured.
The "WhatsApp Number" and "File ID" options are dynamically loaded from the API via helper methods.
Proper permissions and valid IDs must be provided to successfully update quick replies.

Troubleshooting

Invalid Quick Reply ID: If the provided quick reply ID does not exist or is malformed, the API will return an error. Verify the ID format and existence.
Missing Required Fields: Shortcut, message, and WhatsApp number are mandatory. Ensure these are provided and meet length constraints.
File Attachment Issues: When including a media file, ensure the file ID corresponds to a previously uploaded file and is valid.
Permission Errors: Insufficient permissions or invalid permission values may cause failures. Use one of the allowed permission options.
API Authentication Failures: Check that the API key credential is correctly set up and has necessary rights.
Network or Service Unavailability: Temporary connectivity issues with the SparkBot API can cause errors; retry after some time.

Links and References

SparkBot WhatsApp API Documentation (hypothetical link)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API guidelines for quick replies and message templates.

SparkBotInstall