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 → Send Group Invite Link

AI-generated

Summary

Send an invitation link to participants of a group

Inputs

  • groupId (required) — Group ID (e.g., 120363019502650977-group) identifying the target group.
  • participants — Collection of participant phone entries; each entry must contain a required 'phone' field with an international format number (e.g., 5511999999999).

Output shape

array of response objects (one per participant)

Each element mirrors the raw response from the send-text endpoint; the array length equals the number of participants provided.

Examples

Example 1: Invite two contacts to a group

groupId: '120363019502650977-group', participants: [{phone: '5511999999999'}, {phone: '5511888888888'}]

Links

Discussion