SparkBot icon

SparkBot

Interact with SparkBot WhatsApp API

Actions148

Overview

This node interacts with the SparkBot WhatsApp API to manage labels associated with WhatsApp numbers. Specifically, the "Delete Label" operation under the "Labels" resource allows users to remove a label by its name from a specified WhatsApp number. This is useful for organizing and cleaning up labels that categorize chats or contacts in WhatsApp automation workflows.

Practical examples include:

  • Automatically removing outdated or irrelevant labels from contacts after certain events.
  • Managing label lifecycle in bulk when integrated into larger automation processes.

Properties

Name Meaning
WhatsApp number The ID of the WhatsApp number from which the label will be deleted.
Label Name The exact name of the label to delete from the specified WhatsApp number.

Output

The node outputs JSON data representing the result of the delete label operation. Typically, this would include confirmation of successful deletion or details about any error encountered. The output does not include binary data.

Example output JSON might look like:

{
  "success": true,
  "message": "Label deleted successfully"
}

or in case of failure:

{
  "error": "Label not found"
}

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" must be valid and linked to the authenticated account.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent WhatsApp number ID.
    • Specifying a label name that does not exist on the given WhatsApp number.
    • Network or authentication errors due to incorrect API key or connectivity problems.
  • Error messages:

    • "Label not found": The label name provided does not exist for the specified WhatsApp number. Verify the label name spelling and existence.
    • "Unauthorized" or authentication errors: Check that the API key credential is correctly set up and has necessary permissions.
    • Network timeouts or connection errors: Ensure the SparkBot API endpoint is reachable from your environment.

Links and References

Discussion