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 integrates with the SparkBot WhatsApp API to manage labels associated with WhatsApp numbers. Specifically, the Create Label operation allows users to create a new label for a specified WhatsApp number (device). Labels help organize and categorize chats or contacts within the WhatsApp environment, making it easier to filter, search, or automate workflows based on these tags.

Common scenarios where this node is beneficial:

Automatically tagging incoming chats or contacts with specific labels for better segmentation.
Organizing customer conversations by categories such as "Support", "Sales", or "VIP".
Creating color-coded labels to visually distinguish different types of interactions in WhatsApp management tools.

Practical example:

A customer support team wants to tag all chats coming from a particular WhatsApp number with a label named "Priority" colored red. Using this node, they can programmatically create that label and then apply it to relevant chats, streamlining their workflow.

Properties

Name	Meaning
WhatsApp number	The ID of the WhatsApp number (device) for which the label will be created.
Label Name	The name of the label to create.
Label Color	The color of 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	A short description of the label (optional).

Output

The node outputs JSON data representing the result of the label creation operation. This typically includes details about the newly created label such as its ID, name, color, description, and association with the specified WhatsApp number.

If the operation fails and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.

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 WhatsApp number (device) must be valid and accessible via the connected SparkBot account.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID: Ensure the device ID corresponds to a registered WhatsApp number in your SparkBot account.
- Duplicate label names: Some APIs may reject creating labels with names that already exist for the same device.
- Missing required fields: The label name and color are mandatory; omitting them will cause errors.
- Authentication failures: Verify that the API key credential is correctly set up and has sufficient permissions.
Common error messages:
- "Invalid device ID": Check that the WhatsApp number ID is correct.
- "Label name already exists": Use a unique label name or update the existing label instead.
- "Authentication failed": Reconfigure the API key credential.
- "Missing required parameter": Ensure all required properties are provided.

Links and References

SparkBot WhatsApp API Documentation (example placeholder link)
n8n Documentation on Creating Custom Nodes
General information on WhatsApp Business API Labels (for conceptual understanding)

SparkBotInstall