Overview

This node operation deletes a chat in WhatsApp using the Z-API integration. It is useful for automating chat management tasks such as removing unwanted or obsolete chat conversations based on the phone number associated with the chat. For example, it can be used in customer support workflows to clean up chat histories after resolution or in marketing automation to remove chats from inactive contacts.

Use Case Examples

1. Deleting a chat by specifying the phone number with country code to remove the conversation from the WhatsApp instance.
2. Automating chat cleanup in bulk by iterating over multiple phone numbers to delete their respective chats.

Properties

Output

JSON

• json - The JSON response from the Z-API after attempting to delete the chat, which may include success confirmation or error details.

Dependencies

• Requires an API key credential for Z-API to authenticate requests.

Troubleshooting

• Ensure the phone number is provided in the correct format with country code, e.g., '5511999999999'.
• If the chat does not exist or the phone number is incorrect, the API may return an error indicating the chat could not be found.
• Check that the Z-API credentials are correctly configured and have the necessary permissions to delete chats.
• Network or API downtime can cause request failures; verify connectivity and API status if errors occur.