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 allows scheduling WhatsApp messages to be sent via the SparkBot WhatsApp API. It supports sending text messages at a specified future date and time, enabling automation of message delivery for reminders, notifications, marketing campaigns, or customer engagement.

Typical use cases include:

Scheduling appointment reminders to customers.
Sending promotional messages at optimal times.
Automating follow-up messages in customer support workflows.

By specifying the delivery date/time, users can plan communications ahead without manual intervention.

Properties

Name	Meaning
WhatsApp number	The SparkBot Number ID used as the sender for the message delivery.
Target	Type of target chat: Phone (individual), Group, or Channel.
Phone Number	Target phone number in international E.164 format (e.g., +1234567890). Required if Target is Phone.
Group ID	ID of the target group chat (e.g., 12345678902401234@g.us). Required if Target is Group.
Channel ID	ID of the target channel (e.g., 12345678902402200@newsletter). Required if Target is Channel.
Message	Text content of the message to be sent (up to 6000 characters).
Delivery date	Date and time when the message should be delivered (scheduled send time).
Options	Collection of optional settings including: - Priority: Normal, High, Low - Label: Custom label to categorize the message - Reference ID: Custom reference identifier - Team Agent: Send on behalf of an agent - Live mode: Real-time sending without queue (riskier) - Delivery Queue Mode: Controls queuing behavior (default, always queue, never queue, opportunistic) - Maximum Retries: Number of retry attempts for delivery - Chat Actions: Post-delivery actions like assigning chat, resolving, adding/removing labels or metadata
Message Expiration	Defines message TTL (time-to-live) with options to expire after seconds, duration (e.g., "1h"), or specific date/time.
Mark Chat as Read	Boolean to notify WhatsApp that previous unread messages will be marked as read after delivery (blue double-check).
Typing simulation	Seconds to simulate typing or recording status before sending (0 disables). Useful for more natural interaction.
Quote Message	Message ID to quote when sending this message (must be in same conversation).
Strict Message Order	Ensures messages are sent in strict order to the target chat. Not compatible with live mode or never queue delivery. Useful for chatbots or sequences.

Output

The node outputs JSON data representing the result of the scheduled message operation. This typically includes confirmation details such as message IDs, status, and any metadata returned by the SparkBot API.

No binary data output is indicated for this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on SparkBot's backend services for message scheduling and delivery.
Some properties load dynamic options from the API, such as available devices (WhatsApp numbers), groups, channels, labels, team agents, and departments.
Proper configuration of these resources in SparkBot is necessary for successful operation.

Troubleshooting

Invalid phone number format: The phone number must be in E.164 format (e.g., +1234567890). Errors occur if the regex validation fails.
Missing required fields: Ensure that the correct target type is selected and corresponding fields (phone, groupId, or channel) are provided.
Delivery failures: If messages fail to deliver, check the maximum retries setting and delivery queue mode. Using real-time mode ("never queue") for high volume may cause bans or throttling.
Agent or department assignment errors: When using chat actions to assign chats, ensure valid 24-character hexadecimal IDs are provided.
Typing simulation limits: Values must be between 0 and 30 seconds; invalid values may cause errors.
Quote message ID validation: Quoted message IDs must be 18-32 hex characters and belong to the same conversation.
Strict order conflicts: Enabling strict message order is incompatible with live mode or never queue options; avoid combining these settings.

Links and References

WhatsApp Business API Documentation
E.164 Phone Number Format
SparkBot official documentation (refer to your SparkBot provider for detailed API usage and limitations)

SparkBotInstall