z-api by @jaimeflneto icon

z-api by @jaimeflneto

Interact with Z-API to send WhatsApp messages

Overview

This node operation adds participants to a specified community in WhatsApp using the Z-API integration. It is useful for automating the management of community members by programmatically adding multiple phone numbers to a community. For example, it can be used to bulk add users to a community for announcements or group activities.

Use Case Examples

  1. Add multiple phone numbers as participants to a WhatsApp community by specifying the community ID and a comma-separated list of phone numbers.
  2. Automate community member management by integrating this node in workflows that handle user onboarding or group updates.

Properties

Name Meaning
Community ID The unique identifier of the WhatsApp community to which participants will be added.
Participants A comma-separated string of phone numbers representing the participants to add to the community.

Output

JSON

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

Dependencies

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

Troubleshooting

  • Ensure the Community ID is correct and the community exists; otherwise, the operation will fail.
  • Verify that the phone numbers are correctly formatted and separated by commas without extra spaces.
  • Check API key validity and permissions to avoid authentication errors.
  • If the node throws errors related to participant addition, verify that the participants are not already in the community or that the community allows adding new participants.

Links

  • Z-API Documentation - Official documentation for Z-API, which provides details on community management and participant operations.

Discussion