WhatsApi icon

WhatsApi

Connect with WhatApp HTTP API

Overview

This node integrates with a WhatsApp HTTP API to update participants in a WhatsApp group. It allows users to modify the membership of a specified group by adding or removing participants programmatically. This is useful for automating group management tasks such as onboarding new members, removing inactive users, or moderating group composition without manual intervention.

Practical examples include:

  • Automatically adding new customers to a support group when they sign up.
  • Removing users who violate group rules.
  • Managing event-specific groups by updating participants dynamically based on registration status.

Properties

Name Meaning
Phone The session ID representing the phone number or account used to authenticate the request.
To The unique identifier (Jid) of the WhatsApp group where participants will be updated.
Participants A JSON array specifying the participants to add or remove from the group.
Actions The action(s) to perform on the participants, e.g., "add" or "remove".

Output

The node outputs JSON data reflecting the result of the update operation on the group participants. This typically includes confirmation of the changes made, such as which participants were successfully added or removed. There is no indication that binary data is output by this node.

Dependencies

  • Requires connection to a WhatsApp HTTP API service.
  • Needs an API authentication token or key configured in the node credentials.
  • The base URL for the WhatsApp API must be set in the node's credential configuration.

Troubleshooting

  • Invalid Session ID or Authentication Failure: Ensure the session ID (Phone) is correct and the API key/token is valid and active.
  • Incorrect Group Jid: Verify the group identifier is accurate and corresponds to an existing WhatsApp group.
  • Malformed Participants JSON: The participants property must be a valid JSON array; invalid JSON will cause errors.
  • Unsupported Actions: The actions property should contain supported commands like "add" or "remove"; unsupported values may lead to failure.
  • API Connectivity Issues: Check network connectivity and API endpoint availability if requests time out or fail.

Links and References

Discussion