SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

User Status → Update User Status

AI-generated

Overview

This node allows updating a WhatsApp user's status via the SparkBot WhatsApp API integration. It supports posting either text or media content as a status update on a specified WhatsApp number. Users can customize the appearance of text statuses with font styles and background colors, or upload media files (images/videos) with optional captions. Additionally, it supports scheduling status updates to be published immediately or at a later time using delays or specific date/time.

Common scenarios:

  • Broadcasting announcements or promotions as WhatsApp status updates.
  • Sharing images or videos as status stories on WhatsApp.
  • Scheduling status updates for marketing campaigns or timed messages.
  • Customizing text status appearance to match branding or style preferences.

Practical example:

  • A business wants to post a promotional image as a WhatsApp status at 9 AM tomorrow. They use this node to upload the media file URL, set a caption, choose the native format, and schedule the status for the specific date/time.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) where the status will be updated.
Content Type Type of content for the status update. Options: Text, Media.
Message Text content of the status update (max 650 characters). Used only if Content Type is Text.
Font Style Font style for the text status. Options: Helvetica, Serif, Norican. Optional, applies only to text statuses.
Background Color Background color for the text status. Multiple color options such as Red Purple, Moss Green, Sky Blue, etc. Optional, applies only to text statuses.
Reference Optional user-defined reference string for traceability (max 150 characters). Can be used for logging or tracking purposes.
Media Source Source of the media file when Content Type is Media. Options: URL (direct link to media), File ID (previously uploaded file identifier).
File URL URL of the media file (image or video). Required if Media Source is URL.
File ID ID of a previously uploaded media file. Required if Media Source is File ID.
Caption Optional caption text for the media file. Applies only to media content.
File Name Optional filename for the media file. Applies only to media content.
Format Format for displaying the media file. Options: Native, GIF, Voice Recording. Optional, applies only to media content.
Schedule Status Boolean flag indicating whether to schedule the status update for later publication (true) or publish immediately (false).
Schedule Type Method of scheduling when Schedule Status is true. Options: Delay (Seconds), Delay (Time Notation), Specific Date/Time.
Delay (Seconds) Delay in seconds before publishing the status. Required if Schedule Type is Delay (Seconds).
Delay (Time Notation) Delay using human-readable time notation like 15m, 1h, 1d, etc. Required if Schedule Type is Delay (Time Notation).
Date/Time Specific date and time to publish the status. Required if Schedule Type is Specific Date/Time.

Output

The node outputs JSON data representing the result of the status update operation. This typically includes confirmation details such as status update identifiers, timestamps, or success messages returned by the SparkBot WhatsApp API.

If media content is involved, the output may include metadata about the uploaded or referenced media.

No binary data output is indicated for this node.

Dependencies

  • Requires an active connection to the SparkBot WhatsApp API service.
  • Needs an API key credential configured in n8n for authenticating requests to the SparkBot API.
  • The node depends on internal methods to load available WhatsApp numbers (devices) and previously uploaded files for selection.
  • Scheduling functionality relies on the node's ability to handle delayed execution or external scheduling mechanisms.

Troubleshooting

  • Invalid WhatsApp Number: If the selected device ID is incorrect or not linked to the account, the status update will fail. Verify the WhatsApp number is correctly configured and accessible.
  • Content Validation Errors: Text messages exceeding 650 characters or invalid media URLs/file IDs may cause errors. Ensure inputs meet the specified constraints.
  • Scheduling Issues: Incorrect scheduling parameters (e.g., missing delay value or invalid date/time) will prevent status publication. Double-check scheduling fields when enabled.
  • API Authentication Failures: Missing or invalid API key credentials will block communication with the SparkBot API. Confirm that the API key is properly set up in n8n credentials.
  • Unsupported Media Formats: Using unsupported media formats or corrupted files might cause upload failures. Use supported image/video formats and verify file integrity.
  • Network Connectivity: Network issues can cause request timeouts or failures. Ensure stable internet connectivity and access to the SparkBot API endpoints.

Links and References

Discussion