SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node interacts with the SparkBot WhatsApp API to manage WhatsApp chats and related data. Specifically, the "Delete Chat Note" operation under the "Chats" resource allows users to delete one or more notes associated with a particular WhatsApp chat. This is useful for cleaning up or managing metadata attached to chats, such as removing outdated or irrelevant notes.

Practical scenarios include:

  • Automatically deleting notes after a support ticket is resolved.
  • Removing sensitive or temporary annotations from chat histories.
  • Managing chat metadata programmatically in bulk workflows.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number (device) from which the chat originates.
Chat ID The unique identifier of the chat where notes will be deleted. Examples: 447362053576@c.us (user), 44736205357600000000@g.us (group).
Note IDs One or more IDs of the notes to delete from the specified chat.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this would confirm successful deletion or provide details about the deleted notes. If an error occurs, the output JSON contains an error message describing the issue.

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 API service being accessible and properly configured.
  • The "WhatsApp Number" must be registered and active within the SparkBot system.

Troubleshooting

  • Common issues:

    • Invalid or missing WhatsApp Number or Chat ID can cause failures.
    • Providing incorrect Note IDs that do not exist or belong to another chat will result in errors.
    • Network or authentication errors if the API key is invalid or expired.
  • Error messages:

    • "error": "Invalid chat ID" β€” Verify the chat ID format and existence.
    • "error": "Note ID not found" β€” Check that the note IDs are correct and belong to the specified chat.
    • Authentication errors β€” Ensure the API key credential is valid and has necessary permissions.

Resolving these typically involves verifying input parameters and ensuring proper API credentials.

Links and References

Discussion