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 label associated with a specific WhatsApp number. Labels are used to categorize or tag chats, contacts, or messages within the WhatsApp environment, helping users organize and filter their conversations effectively.

Typical use cases include:

Changing the name or color of a label to better reflect its purpose.
Adding or updating a description for clarity.
Managing labels dynamically as part of automated workflows that organize WhatsApp communications.

For example, a user might update a label named "Support" to change its color from blue to red to indicate urgency or modify its description to specify it is for high-priority customer issues.

Properties

Name	Meaning
WhatsApp number	The ID of the WhatsApp number (device) on which the label exists and will be updated.
Label Name	The new or existing name of the label to update.
Label Color	The color assigned to the label. Options include: Ruby, Tomato, Orange, Sunflower, Bubble, Rose, Poppy, Rouge, Raspberry, Purple, Lavender, Violet, Pool, Emerald, Kelly, Apple, Turquoise, Aqua, Gold, Latte, Cocoa, Iron.
Description	An optional short description providing additional details about the label.

Output

The node outputs JSON data representing the updated label object returned by the SparkBot API. This typically includes fields such as the label's ID, name, color, description, and possibly metadata confirming the update status.

No binary data output is produced by this operation.

Dependencies

Requires an active connection to the SparkBot WhatsApp API.
Needs an API key credential configured in n8n for authentication.
The WhatsApp number (device ID) must be valid and linked to the authenticated account.

Troubleshooting

Common Issues:
- Invalid or missing WhatsApp number/device ID can cause failures.
- Using a label name that does not exist may result in errors.
- Insufficient permissions or invalid API key will prevent successful updates.
Error Messages:
- "Label not found": The specified label name does not exist on the given WhatsApp number. Verify the label name and device ID.
- "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set up and has necessary permissions.
- "Invalid color value": Ensure the color property matches one of the allowed options.

Resolving these usually involves verifying input parameters, ensuring correct credentials, and confirming the label exists before attempting an update.

Links and References

SparkBot WhatsApp API Documentation (general reference for label management)
n8n Documentation on Creating Custom Nodes

SparkBotInstall