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 → Create Group

AI-generated

Summary

Create a new WhatsApp group with optional description, auto‑invite, and participant list.

Inputs

  • groupName (required) — Name of the group to be created in Z‑API.
  • groupDescription — Optional description for the group.
  • autoInvite — Whether to automatically send private invites to participants who cannot be added directly.
  • participants — Collection of participant phone numbers in international format; at least one phone is needed for group creation.

Output shape

object

Returns the group creation response (e.g., group ID and metadata); may vary per API version, and only success or error information is guaranteed on failure.

Examples

Example 1: Create a group named 'Marketing Team'

Set Resource to Groups, Operation to Create Group, fill Group Name, optionally Description, enable Auto Invite, add participant phone numbers.

Links

Discussion