Wappfy icon

Wappfy

Interact with WhatsApp through Wappfy API

Overview

This node interacts with WhatsApp groups via the Wappfy API, specifically enabling the removal of a participant from a group. It is useful in scenarios where you need to programmatically manage group membership, such as moderating group participants or automating group maintenance tasks.

For example, if a user needs to remove a specific phone number or participant ID from a WhatsApp group, this node operation facilitates that by sending the appropriate request to the Wappfy API to remove the participant.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group from which a participant will be removed.
Participant ID The phone number or WhatsApp ID of the participant to be removed from the group.

Output

The output is a JSON object representing the response from the Wappfy API after attempting to remove the participant. This typically includes confirmation of the removal or details about the updated group state.

If multiple items are processed, the output is an array of such JSON objects, one per input item.

No binary data output is produced by this operation.

Dependencies

  • Requires an active Wappfy API credential with:

    • Base URL of the Wappfy API.
    • Instance name identifying the WhatsApp session.
    • An API key for authentication.
  • The node sends HTTP POST requests to the endpoint:

    /api/{instanceName}/groups/{groupId}/participants/remove
    

    with a JSON body specifying the participant to remove.

  • Proper configuration of the Wappfy API credentials in n8n is necessary.

Troubleshooting

  • Common Issues:

    • Invalid or missing Group ID or Participant ID parameters will cause the API call to fail.
    • Incorrect API credentials or expired session may result in authentication errors.
    • Attempting to remove a participant who is not in the group may return an error or no effect.
  • Error Messages:

    • Authentication errors: Check API key and instance name correctness.
    • "Participant not found": Verify the participant ID is correct and currently in the group.
    • Network or timeout errors: Ensure the Wappfy API base URL is reachable and stable.
  • To resolve errors, verify all input parameters, ensure valid credentials, and confirm the participant's presence in the group before removal.

Links and References

  • Wappfy API Documentation (general reference for API endpoints)
  • WhatsApp Group Management concepts (for understanding group and participant IDs)

This summary focuses on the "Group" resource and the "Remove Participant" operation as requested.

Discussion