Maytapi icon

Maytapi

Integrate with Maytapi WhatsApp Unofficial API

Actions55

Group → Remove Participant

AI-generated

Overview

This node integrates with the Maytapi WhatsApp Unofficial API to manage WhatsApp groups and participants. Specifically, the "Remove Participant" operation under the "Group" resource allows you to remove a participant from a specified WhatsApp group by providing the group ID and the participant's phone number.

Common scenarios where this node is beneficial include:

  • Moderating WhatsApp groups by removing unwanted or inactive members.
  • Automating group management tasks in customer support or community engagement workflows.
  • Integrating WhatsApp group participant management into broader automation pipelines.

For example, you can use this node to automatically remove users who violate group rules or to clean up groups after events.

Properties

Name Meaning
Phone ID Source Select how to provide the Phone ID: either "From Credentials" (uses stored credentials) or "Custom" (enter manually).
Phone ID The WhatsApp instance Phone ID, required if "Custom" Phone ID Source is selected.
Group ID The unique identifier of the WhatsApp group (conversation ID ending with @g.us).
Participant Number The phone number of the participant to remove (without the @c.us suffix).

Output

The node outputs JSON data representing the response from the Maytapi API after attempting to remove the participant. This typically includes success status and any relevant messages or error details returned by the API.

No binary data output is produced for this operation.

Example output JSON structure:

{
  "success": true,
  "message": "Participant removed successfully"
}

or in case of failure:

{
  "error": "Participant not found in group"
}

Dependencies

  • Requires an active Maytapi WhatsApp API account with valid API credentials.
  • The node expects an API key credential configured in n8n to authenticate requests.
  • The Phone ID must be provided either via credentials or as a custom input.
  • Internet access to the Maytapi API endpoint (https://api.maytapi.com/api) is necessary.

Troubleshooting

  • Missing Phone ID: If neither credentials nor custom Phone ID is provided, the node will throw an error stating that the Phone ID is required. Ensure you have set the Phone ID correctly.
  • Invalid Group ID or Participant Number: Providing incorrect or malformed IDs may cause API errors. Verify the group ID ends with @g.us and the participant number does not include the @c.us suffix.
  • API Errors: The Maytapi API might return errors if the participant is not part of the group or if permissions are insufficient. Check the API response message for details.
  • Network Issues: Connectivity problems to the Maytapi API endpoint will cause request failures. Confirm network access and API availability.
  • Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error details in the output JSON.

Links and References

Discussion