z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node operation removes participants from a specified WhatsApp group using the Z-API integration. It is useful for managing group membership by programmatically removing one or more participants based on their phone numbers. For example, it can be used in automated workflows to moderate group membership or clean up inactive members.

Use Case Examples

  1. Removing multiple participants from a group by providing their phone numbers separated by commas.
  2. Automating group management by removing participants who no longer meet certain criteria.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group from which participants will be removed.
Participants Comma-separated phone numbers of the participants to be removed from the group.

Output

JSON

  • json - The JSON response from the Z-API after attempting to remove the specified participants from the group, typically including success or error details.

Dependencies

  • Requires Z-API credentials for authentication to interact with the WhatsApp API.

Troubleshooting

  • Ensure the Group ID is correct and the bot or API user has permission to modify the group.
  • Verify that the phone numbers in Participants are correctly formatted and separated by commas.
  • Common errors may include invalid group ID, unauthorized access, or invalid participant numbers. Check API response messages for specific error details.

Links

  • Z-API Documentation - Official documentation for Z-API, which provides details on group management and participant removal endpoints.

Discussion