Actions37
- Message Actions
- Media Actions
- Contact Actions
- Group Actions
- Instance Actions
- Webhook Actions
Overview
This node integrates with a premium WhatsApp API service to manage WhatsApp groups and participants programmatically. Specifically, the "Add Participant" operation 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, community chats, or team collaboration groups on WhatsApp without manual intervention.
For example, a business can automatically add new customers to a WhatsApp group for product updates by providing the group ID and the customers' phone numbers separated by commas.
Properties
| Name | Meaning |
|---|---|
| Group ID | The unique identifier of the WhatsApp group where 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 details about the operation's success or failure.
If the operation fails, the output JSON will contain an error message describing the issue.
No binary data is produced by this operation.
Dependencies
- Requires an active connection to the premium WhatsApp API service.
- Needs valid credentials including an API key, API token, instance ID, and API URL configured in n8n.
- The node sends requests through a proxy endpoint provided by the integration service.
Troubleshooting
- Invalid Group ID: If the group ID does not exist or is incorrect, the API will return an error. Verify the group ID is correct.
- Invalid Phone Numbers: Phone numbers must be in international format without spaces or special characters. Incorrect formatting may cause failures.
- Permission Issues: The authenticated WhatsApp instance must have permission to add participants to the group.
- API Rate Limits: Adding many participants at once or frequent calls might hit rate limits imposed by the WhatsApp API provider.
- Network or Credential Errors: Ensure that API credentials are valid and network connectivity to the API endpoint is stable.
If errors occur, check the error message returned in the output JSON for guidance.
Links and References
- WhatsApp Group Management API Documentation
- n8n Documentation on Creating Custom Nodes
- Uazapi Premium WhatsApp API (provider of the integrated API)