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 retrieve profile information related to a specified WhatsApp number. Specifically, the "Get Profile" operation under the "WhatsApp profile" resource fetches details about a WhatsApp device/profile associated with the given number.

Common scenarios where this node is useful include:

Retrieving metadata or status information about a WhatsApp number managed via SparkBot.
Verifying profile details before sending messages or performing other operations.
Integrating WhatsApp profile data into workflows for customer support, marketing, or analytics.

Example use case: A user wants to check the profile information of a WhatsApp number to confirm it is active and correctly configured before initiating a messaging campaign.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) whose profile you want to retrieve. This is selected from available devices loaded dynamically.
Include Options	Optional string to specify additional data to include in the response when fetching the profile.

Output

The node outputs JSON data representing the profile information of the specified WhatsApp number. This typically includes details such as profile name, status, and possibly other metadata returned by the SparkBot API.

If the "Include Options" property is used, the output may contain extended information as requested.

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 SparkBot service being accessible and properly configured.
The "WhatsApp Number" options are dynamically loaded, implying the node fetches available devices from the API.

Troubleshooting

Common issues:
- Invalid or missing API key credential will cause authentication failures.
- Selecting a WhatsApp number that does not exist or is inactive may result in errors or empty responses.
- Network connectivity problems can prevent successful API calls.
Error messages:
- Authentication errors: Verify that the API key credential is correctly set up.
- Device not found: Ensure the WhatsApp number/device ID is valid and currently registered.
- Unexpected API errors: Check SparkBot service status and review any rate limits or usage restrictions.

Links and References

SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if known)
n8n Documentation on Creating Custom Nodes
General WhatsApp Business API references for context on profile data structures.

SparkBotInstall