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 operation updates the configuration of a WhatsApp number managed via the SparkBot WhatsApp API. It allows users to modify various settings such as enabling or disabling the number, changing its alias and description, adjusting billing plans, setting webhook restrictions, and configuring policies related to rebooting, data retention, and message delivery speed.

Typical use cases include:

Changing the display name or description of a WhatsApp number for better identification.
Enabling or disabling a WhatsApp number without deleting it.
Updating billing plans to upgrade or downgrade service levels.
Restricting webhook notifications to specific endpoints.
Managing device session reboot schedules.
Setting how long message data is retained.
Controlling the maximum message delivery rate per minute to comply with limits or optimize throughput.

For example, a business might update a WhatsApp number's alias to reflect a new campaign name, adjust the delivery speed to handle increased messaging volume, or disable a number temporarily during maintenance.

Properties

Name	Meaning
WhatsApp Number ID	The unique identifier of the WhatsApp number to update. This is required to specify which number's settings will be changed.
Update Fields	A collection of fields to update on the WhatsApp number. These include:
Enable	Boolean flag to enable (`true`) or disable (`false`) the WhatsApp number.
Alias	New alias or name for the WhatsApp number, between 2 and 30 characters.
Description	New description text for the WhatsApp number, up to 80 characters.
Billing Plan	Select a new billing plan for the number. Options include: Professional, Business, Enterprise, Gateway Professional, Gateway Business, Gateway Enterprise, Platform Professional, Platform Business, Platform Enterprise. Charges may apply.
Webhook IDs	List of webhook endpoint IDs to restrict notifications to. Only these webhooks will receive events from this number.
Reboot Policy	Device session reboot schedule policy. Options range from Disabled to intervals between 10 minutes and 18 hours.
Retention Policy	Data retention duration for messages and related data. Options include Plan Defaults, Never, and durations from 5 minutes up to 10 days.
Delivery Speed	Maximum message delivery speed per minute. Options range from Plan Default to values between 0.1 and 150 messages per minute.

Output

The node outputs JSON data representing the updated WhatsApp number object returned by the SparkBot API after applying the changes. This typically includes the current state of all properties of the WhatsApp number, reflecting the updates made.

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 depends on the SparkBot API supporting the update operations for WhatsApp numbers.

Troubleshooting

Common issues:
- Invalid WhatsApp Number ID: Ensure the provided ID corresponds to an existing number.
- Validation errors on fields like alias length or description length.
- Billing plan changes may fail if the account does not support the selected plan or if charges are not authorized.
- Webhook IDs must be valid and associated with the account.
- Delivery speed values outside allowed ranges may cause errors.
Error messages:
- "Invalid WhatsApp Number ID": Check that the ID is correct and the number exists.
- "Field validation failed": Verify that all input fields meet the specified constraints (e.g., alias length).
- "Unauthorized" or "Authentication failed": Confirm that the API key credential is correctly set up.
- "Billing plan update failed": Review account permissions and billing status.
To resolve errors, verify input parameters, ensure proper API credentials, and consult the SparkBot API documentation for limits and requirements.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation on Creating Custom Nodes
Best practices for managing WhatsApp Business API numbers and configurations (consult official WhatsApp Business API resources)

SparkBotInstall