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
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
Files Actions
- Search Files
- Upload File
- Delete Files
- Get File Preview
- Download File
- Get File
- Update File
- Delete File
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

Chat Contacts → Update Contact Metadata

AI-generated

Overview

This node interacts with the SparkBot WhatsApp API to update metadata associated with a specific contact on a given WhatsApp number. It is useful in scenarios where you want to enrich or modify contact information dynamically by adding custom key-value pairs as metadata. For example, you might tag contacts with customer status, preferences, or any other relevant attributes that your business logic requires.

Practical examples include:

Adding loyalty program membership details to a contact.
Tagging contacts with their preferred language or region.
Storing temporary flags or notes for follow-up actions.

Properties

Name	Meaning
WhatsApp Number	The ID of the WhatsApp number (device) from which the contact belongs.
Contact ID	The unique identifier of the contact (e.g., `447362053576@c.us`) whose metadata will be updated.
Metadata	One or more key-value pairs representing metadata to add or update for the contact. Keys must be alphanumeric or underscores; values can be up to 300 characters.

Output

The node outputs JSON data representing the result of the metadata update operation. This typically includes confirmation of the updated metadata or the updated contact object as returned by the SparkBot API.

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 SparkBot service being accessible and properly configured.
The "WhatsApp Number" (device) must be valid and linked to the authenticated account.
The contact ID must exist within the specified WhatsApp number's contacts.

Troubleshooting

Invalid Contact ID: If the contact ID does not exist or is malformed, the API may return an error. Verify the contact ID format and existence.
Invalid Metadata Key/Value: Metadata keys must be alphanumeric or underscores only, and values must not exceed 300 characters. Violations may cause errors.
Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
Device Not Found: The WhatsApp number (device) ID must be valid and active; otherwise, the operation will fail.
API Rate Limits or Network Issues: Temporary failures may occur due to rate limits or connectivity problems. Retrying or checking network status may help.

Links and References

SparkBot WhatsApp API Documentation (general reference for API capabilities)
n8n Documentation on Creating Custom Nodes
Best practices for managing WhatsApp contacts and metadata in SparkBot environments.

SparkBotInstall