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 provides an interface to interact with the "Campaigns" resource of the SparkBot WhatsApp API, specifically allowing users to update the status of a campaign. The main operation supported here is updating a campaign's status by either starting or stopping it.

This node is beneficial in scenarios where automated control over marketing or communication campaigns is needed within a WhatsApp environment. For example, a user can programmatically start a campaign when certain conditions are met (e.g., a new product launch) or stop it based on real-time feedback or scheduling requirements.

Practical examples:

Automatically start a promotional campaign at a scheduled time.
Stop a campaign immediately if a critical issue is detected.
Integrate campaign control into larger workflows that manage customer engagement.

Properties

Name	Meaning
Campaign ID	The unique identifier of the campaign to be updated.
Action	The action to perform on the campaign. Options: "Start Campaign" or "Stop Campaign".

Output

The node outputs JSON data representing the result of the campaign status update operation. This typically includes confirmation of the action performed and any relevant metadata returned by the SparkBot API about the campaign's new state.

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 the external SparkBot WhatsApp API service to perform campaign operations.
Proper configuration of the API key credential in n8n is necessary for successful execution.

Troubleshooting

Common issues:
- Invalid or missing Campaign ID: Ensure the Campaign ID provided exists and is correctly formatted.
- Authentication errors: Verify that the API key credential is valid and has the necessary permissions.
- Network or API downtime: Check connectivity and SparkBot API status.
Error messages:
- "error": "Invalid Campaign ID" — Confirm the campaign ID is correct.
- "error": "Unauthorized" — Recheck API key credentials and permissions.
- "error": "Action not allowed" — Ensure the action ("start" or "stop") is valid for the current campaign state.

Resolving these usually involves verifying input parameters, credentials, and network connectivity.

Links and References

SparkBot WhatsApp API documentation (refer to official docs for detailed campaign management endpoints)
n8n documentation on creating and using API key credentials
General best practices for managing WhatsApp campaigns via APIs

SparkBotInstall