N8N Tools - Uazapi icon

N8N Tools - Uazapi

Complete Uazapi integration - Premium WhatsApp API with advanced messaging and automation

Actions37

Overview

This node integrates with a premium WhatsApp API service to manage WhatsApp groups and participants programmatically. Specifically, the "Add Participant" operation under the "Group" resource allows users to add one or more phone numbers as participants to an existing WhatsApp group.

Common scenarios where this node is beneficial include automating group management tasks such as onboarding new members into customer support groups, marketing broadcast groups, or team collaboration groups on WhatsApp without manual intervention.

For example, a business could automatically add new customers who opt-in via a web form to a WhatsApp group for announcements or support, streamlining communication workflows.

Properties

Name Meaning
Group ID The unique identifier of the WhatsApp group to which participants will be added.
Participants Comma-separated list of phone numbers (with country code) to add as participants to the group. Example: 5511999999999,5511888888888
Additional Fields Optional extra parameters:
- Reply to Message ID: ID of a message to reply to.
- Delay (seconds): Delay before sending the request.
- Disable Link Preview: Whether to disable link previews in messages.
- Mention Users: Comma-separated phone numbers to mention in messages.

Output

The node outputs a JSON object containing the response from the WhatsApp API after attempting to add participants to the specified group. This typically includes confirmation of success or details about any errors encountered.

The output structure is:

{
  "json": {
    // API response data confirming participant addition or error details
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the premium WhatsApp API service.
  • Needs configuration of API credentials including:
    • An API key credential for authentication.
    • API URL endpoint.
    • API token for authorization.
    • Instance ID representing the WhatsApp instance.
  • These credentials must be set up in n8n prior to using the node.

Troubleshooting

  • Invalid Group ID: If the provided Group ID does not exist or is malformed, the API will return an error. Verify the Group ID is correct.
  • Incorrect Phone Number Format: Phone numbers must include country codes and be comma-separated without spaces. Improper formatting may cause failures.
  • API Authentication Errors: Ensure that the API key, token, and instance ID are correctly configured and valid.
  • Rate Limits or Quotas: Adding many participants rapidly might hit API rate limits; consider adding delays using the "Delay (seconds)" additional field.
  • Permission Issues: The WhatsApp instance or API user must have permissions to modify group participants.

If the node throws an error, check the error message returned in the output JSON for specific API error details.

Links and References

Discussion