Actions148
- Chats Actions
- Chat Contacts Actions
- Chat Messages Actions
- Chat Files Actions
- Files Actions
- Team Actions
- Labels Actions
- Departments Actions
- Quick replies Actions
- Queue Actions
- WhatsApp session Actions
- WhatsApp profile Actions
- Business catalog Actions
- Campaigns Actions
- Meeting Links Actions
- User Status Actions
- Webhooks Actions
- Other Actions
- Send messages Actions
- Outbound Messages Actions
- WhatsApp Numbers Actions
- Groups Actions
- Channels Actions
Overview
This node integrates with the SparkBot WhatsApp API to update an existing WhatsApp channel's details. It allows users to modify properties such as the channel's name, description, profile image, and associate it with a specific WhatsApp number.
Typical use cases include:
- Renaming a WhatsApp channel to reflect new branding or campaign focus.
- Updating the channel description to provide more context or information.
- Changing the channel's profile picture by specifying a new image URL.
- Managing multiple WhatsApp numbers and their associated channels dynamically within automation workflows.
For example, a marketing team could automate updating channel details when launching a new promotion, ensuring all channel metadata is current without manual intervention.
Properties
| Name | Meaning |
|---|---|
| WhatsApp Number | The ID of the WhatsApp number to which the channel belongs. This identifies the device/account used. |
| Channel ID | The unique identifier of the channel to update (e.g., 123000098765421000 or 123000098765421000@newsletter). |
| Channel Name | The new name for the channel. |
| Description | Optional. A textual description of the channel, up to 2048 characters. |
| Image URL | Optional. URL pointing to an image (JPG or PNG, max 1MB) to be used as the channel's profile picture. |
Output
The node outputs JSON data representing the updated channel object returned from the SparkBot API. This typically includes the updated channel properties such as its ID, name, description, image URL, and possibly status or metadata fields confirming the update.
No binary data output is produced by 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 the provided WhatsApp number and channel IDs being valid.
- Network connectivity to the SparkBot API endpoint is necessary.
Troubleshooting
- Invalid Channel ID: If the channel ID does not exist or is malformed, the API will likely return an error. Verify the channel ID format and existence before running the node.
- Unauthorized / Authentication Errors: Ensure the API key credential is correctly configured and has sufficient permissions.
- Image URL Issues: If providing an image URL, ensure it points to a valid JPG or PNG file under 1MB. Invalid URLs or unsupported formats may cause the update to fail.
- Description Length: Descriptions longer than 2048 characters might be rejected by the API.
- WhatsApp Number Not Found: The specified WhatsApp number must be registered and available in the SparkBot system.
If errors occur, enabling "Continue On Fail" can help process multiple items while logging individual failures.
Links and References
- SparkBot WhatsApp API Documentation (example placeholder, replace with actual URL if known)
- n8n Documentation on Creating Custom Nodes
- Best practices for managing WhatsApp channels via APIs
Note: This summary is based solely on static analysis of the provided source code and property definitions.