Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.wazzapi.com/llms.txt

Use this file to discover all available pages before exploring further.

WhatsApp Groups

The Groups API lets you manage WhatsApp groups directly through your connected sessions. You can list groups, send messages, manage participants, and configure group settings.

Listing Groups

List all WhatsApp groups your session is subscribed to:
curl -X GET "https://api.wazzapi.com/api/v1/groups?session_name=my-session&limit=50" \
  -H "Authorization: Bearer YOUR_API_KEY"

Sending Messages to Groups

Send text or media messages to a WhatsApp group:
curl -X POST https://api.wazzapi.com/api/v1/groups/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_name": "my-session",
    "group_jid": "[email protected]",
    "text": "Hello everyone!"
  }'
The API looks up the group name from the WhatsApp backend and stores it with the message record, so message history displays “Super Group” instead of the raw JID.

Supported Message Types

TypeEndpointSupported
TextPOST /groups/send
ImagePOST /groups/send/media
VideoPOST /groups/send/media
VoicePOST /groups/send/media
DocumentPOST /groups/send/media
Template
Interactive
Location
Contact card

Group Management

Participants

Add, remove, promote, or demote participants:
curl -X POST https://api.wazzapi.com/api/v1/groups/participants \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_name": "my-session",
    "group_jid": "[email protected]",
    "action": "add",
    "participants": ["[email protected]"]
  }'

Group Settings

Update group name, topic, photo, and permissions:
# Set group name
curl -X POST https://api.wazzapi.com/api/v1/groups/[email protected]/name \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_name": "my-session",
    "name": "New Group Name"
  }'

# Lock group (admins only)
curl -X POST https://api.wazzapi.com/api/v1/groups/[email protected]/locked \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_name": "my-session",
    "locked": true
  }'
Get or use invite links:
# Get invite link
curl -X POST "https://api.wazzapi.com/api/v1/groups/[email protected]/invite-link?session_name=my-session" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Join via invite link
curl -X POST https://api.wazzapi.com/api/v1/groups/join \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "session_name": "my-session",
    "invite_link": "https://chat.whatsapp.com/HffXhYmzzyJGec61oqMXiz"
  }'

Message History

Messages sent to groups include group metadata in the response:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "phone_number": "[email protected]",
  "chat_type": "group",
  "group_jid": "[email protected]",
  "group_name": "Super Group",
  "content": "Hello everyone!",
  "status": "sent",
  "direction": "outbound"
}
FieldDescription
chat_typeindividual or group
group_jidThe group’s WhatsApp JID
group_nameHuman-readable group name (looked up at send time)