SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node allows users to delete quick replies associated with a WhatsApp number via the SparkBot WhatsApp API. Quick replies are predefined message templates or shortcuts that can be used to speed up conversations. The node supports deleting either all quick replies for a given WhatsApp number or specific quick replies identified by their ID or shortcut.

Common scenarios include:

  • Cleaning up outdated or unused quick replies in bulk.
  • Removing specific quick replies that are no longer relevant or were created by mistake.
  • Managing quick replies programmatically as part of WhatsApp automation workflows.

Example use case:

  • A customer support team wants to remove all quick replies related to a discontinued product from their WhatsApp number.
  • An automated workflow deletes specific quick replies after a campaign ends, based on their shortcut names.

Properties

Name Meaning
WhatsApp Number The ID of the WhatsApp number from which quick replies will be deleted.
Delete Method Method to use for deleting quick replies: either "Delete All Quick Replies" or "Delete by ID or Shortcut".
Items to Delete When using "Delete by ID or Shortcut", specify one or more items to delete. Each item requires:
- Type: whether the identifier is an "ID" or a "Shortcut".
- ID: the unique ID of the quick reply (if type is ID).
- Shortcut: the shortcut string of the quick reply (if type is Shortcut).

Output

The node outputs JSON data representing the result of the delete operation(s). This typically includes confirmation of deletion or error details if the operation failed. The output structure depends on the API response but generally confirms which quick replies were deleted.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the SparkBot WhatsApp API.
  • Needs an API key credential configured in n8n for authentication with the SparkBot service.
  • The WhatsApp number must be registered and accessible via the API.

Troubleshooting

  • Common issues:

    • Providing an invalid WhatsApp number ID may cause the operation to fail.
    • Attempting to delete quick replies that do not exist (wrong ID or shortcut) will likely return errors or no action.
    • Network or authentication failures due to missing or incorrect API credentials.
  • Error messages:

    • Errors indicating "not found" usually mean the specified quick reply ID or shortcut does not exist.
    • Authentication errors suggest problems with the API key or permissions.
    • To resolve, verify the WhatsApp number ID, quick reply identifiers, and ensure the API key is valid and has required permissions.

Links and References

  • SparkBot WhatsApp API documentation (for quick replies management) β€” consult the official API docs provided by SparkBot for detailed info on quick replies endpoints and parameters.
  • n8n documentation on creating and managing credentials for API integrations.

Discussion