Z-API WhatsApp icon

Z-API WhatsApp

Integration with Z-API (WhatsApp) organized by resources (messages, groups, chats, contacts, products, queue, instance, status, etc.).

Group → Add Participant

AI-generated

Summary

Add one or more participant phone numbers to a WhatsApp group.

Inputs

  • groupId (required) — Group ID in international format (e.g., 120363019502650977-group).
  • autoInvite — Whether to send a private invite to participants who cannot be added directly (default true).
  • participants (required) — Collection of participant objects, each containing a required 'phone' field in international format.

Output shape

object representing the API response (e.g., success status, error details).

Response may include a success message or error information; shape is not formally defined by the node.

Examples

Example 1: Add two participants to an existing group.

groupId = 120363019502650977-group; autoInvite = true; participants = [{phone:"5511999999999"},{phone:"5511888888888"}]

Example 2: Add a single participant without auto‑invite.

groupId = 120363019502650977-group; autoInvite = false; participants = [{phone:"5511777777777"}]

Links

Discussion