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 integrates with the SparkBot WhatsApp API to perform various operations related to WhatsApp messaging and management. Specifically, for the WhatsApp profile resource with the Get Profile Image operation, it retrieves the profile image associated with a specified WhatsApp number.

Common scenarios where this node is beneficial include:

Fetching the profile picture of a WhatsApp contact or business number for display in dashboards or CRM systems.
Automating the retrieval of profile images to enrich contact data.
Using profile images in customer support or marketing workflows to personalize interactions.

Example: A user wants to display the profile image of a WhatsApp number in their internal app. They configure this node to get the profile image by selecting the WhatsApp profile resource and the Get Profile Image operation, providing the target WhatsApp number.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number whose profile image you want to retrieve. This is selected from available WhatsApp numbers linked to your account.

Output

The node outputs JSON data containing the profile image information of the specified WhatsApp number. The exact structure depends on the API response but typically includes:

URL or base64 data of the profile image.
Metadata such as image format or size (if provided by the API).

If the profile image is returned as binary data, it would be accessible in the node's binary output field, representing the actual image file.

Dependencies

Requires an active connection to the SparkBot WhatsApp API via an API key credential configured in n8n.
The node depends on the availability of WhatsApp numbers linked to the SparkBot account; these are loaded dynamically for selection.
Network access to the SparkBot API endpoints is necessary.

Troubleshooting

Common issues:
- Invalid or missing WhatsApp number ID: Ensure the WhatsApp number is correctly selected and linked to your SparkBot account.
- API authentication errors: Verify that the API key credential is valid and has the required permissions.
- No profile image available: Some WhatsApp numbers may not have a profile image set; handle empty or null responses gracefully.
Error messages:
- "error": "Invalid WhatsApp number" — Check if the WhatsApp number exists and is active.
- "error": "Authentication failed" — Reconfigure the API key credential.
- Network timeouts or unreachable API — Confirm network connectivity and API endpoint status.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation for configuring credentials and using nodes

Note: This summary is based on static analysis of the bundled source code and provided property definitions without runtime execution.

SparkBotInstall