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 "Create Chat Note" operation in the Chats resource allows users to add a textual note to a specific WhatsApp chat associated with a given WhatsApp number (device). This note can include rich text formatting supported by WhatsApp and optionally quote an existing message or note. It also supports specifying an author from the team agents.

This node is useful for customer support teams, sales agents, or any user who wants to annotate chats with internal notes directly linked to conversations on WhatsApp. For example, a support agent might add a note summarizing a customer's issue or next steps after a call, which can be referenced later by other team members.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the chat belongs.
Chat ID	The unique identifier of the chat where the note will be created (e.g., user or group chat ID).
Note Message	The text content of the note to add to the chat. Supports WhatsApp rich text syntax; length 2-6000 chars.
Quote Message ID	(Optional) The ID of an existing message or note to quote in this new note.
Author ID	(Optional) The user ID of the team agent who authored the note.

Output

The output JSON contains the response from the API after creating the chat note. This typically includes details about the newly created note such as its ID, content, timestamp, author, and any quoted message reference.

No binary data output is involved in this operation.

Dependencies

Requires an API key credential for authenticating with the SparkBot WhatsApp API.
The node depends on the availability of the WhatsApp number (device) and valid chat IDs.
Loading options for WhatsApp numbers and team agents are dynamically fetched via methods (getDevices and getTeamAgents).

Troubleshooting

Invalid Chat ID: If the chat ID does not exist or is malformed, the API may return an error. Verify the chat ID format (e.g., 447362053576@c.us for users, 44736205357600000000@g.us for groups).
Unauthorized Access: Missing or invalid API key credentials will cause authentication failures.
Note Message Length: Ensure the note message is between 2 and 6000 characters; otherwise, the API may reject it.
Author ID Issues: Specifying an author ID that is not part of the team or not linked to the device may cause errors.
Quoting Nonexistent Messages: Quoting a message ID that does not exist or is not accessible will likely result in an error.

To resolve these issues, verify all input parameters, ensure proper API credentials, and confirm that referenced messages and authors exist and are accessible.

Links and References

WhatsApp Rich Text Formatting
SparkBot WhatsApp API documentation (refer to your API provider's official docs for detailed endpoints and parameters)

SparkBotInstall