Groups - Notifique

WhatsApp groups are where classes, teams, and communities chat together. With Notifique you send alerts to the whole group, manage participants, and share invite links, unofficial connection only (number paired via QR or shareable link).

In brief

Unofficial connection only, official (Meta) instances cannot send to or manage groups via API.
Use the same instance you already paired for 1-to-1 sends.
API key with whatsapp:groups scope on integrations that need it.
Group send = same message route; only to changes (...@g.us).

Official line: groups, participants, and invites are not available. Use an unofficial connection or 1-to-1 on the official line.

When to use

Situation	Use groups via API?
Alerts to multiple classes/teams (unofficial)	Yes
Automate invites and participants via ERP/CRM	Yes
Official (Meta) instance	No, use 1-to-1 or switch to unofficial
Only 1-to-1 support	No. Use standard WhatsApp

Full comparison: Connection modes.

What you can do

Send to a group

POST /v1/whatsapp/messages with group JID in to (120363...@g.us).

List groups

GET /v1/whatsapp/instances/{id}/groups with pagination.

Participants

List, add, and remove people in allowed groups.

Invites

Send invite link in DM, revoke, or fetch invite code.

Routes and fields: WhatsApp API reference (Groups section).

Before you start

Item	Required
Unofficial ACTIVE instance	Yes
`whatsapp:groups` scope on key	Yes
Number is admin in target groups	Recommended

Not paired yet? WhatsApp Quick Start (unofficial tab). Scopes: API Key scopes. Replace sk_live_xxxxx with your key and {instanceId} with the instance id. Base URL: https://api.notifique.dev.

The API Key belongs to one workspace. On v1 do not send x-workspace-id.

1. List groups

Returns a paginated list of groups for the instance.

GET /v1/whatsapp/instances/{instanceId}/groups?page=1&limit=20
Authorization: Bearer sk_live_xxxxx

Optional params: page (default 1), limit (default 20, max 100). With groups loaded

{
  "success": true,
  "data": [
    {
      "id": "120363295648424210@g.us",
      "name": "My Group",
      "participantsCount": 5,
      "owner": "5511999999999@s.whatsapp.net",
      "creation": 1699000000
    }
  ],
  "pagination": { "page": 1, "limit": 20, "total": 5 }
}

Still syncing

{
  "success": true,
  "loading": true,
  "message": "Group list is loading. Try again in a few seconds.",
  "data": [],
  "pagination": { "page": 1, "limit": 20, "total": 0 }
}

Save the id (e.g. 120363295648424210@g.us) for the next steps.

Group participants

GET /v1/whatsapp/instances/{instanceId}/groups/120363295648424210@g.us/participants
Authorization: Bearer sk_live_xxxxx

In the URL, encode @ as %40 if your client requires it.

{
  "success": true,
  "data": {
    "participants": [
      { "id": "5511999999999@s.whatsapp.net", "admin": "superadmin" },
      { "id": "5511888888888@s.whatsapp.net", "admin": "admin" }
    ]
  }
}

2. Send a message to a group

Same route as individual WhatsApp sends. Put the group JID in to.

POST /v1/whatsapp/messages
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "instanceId": "clxx...",
  "to": ["120363295648424210@g.us"],
  "type": "text",
  "payload": {
    "message": "Hello, group! Alert sent via API."
  }
}

Response (202)

{
  "messageIds": ["clxx1..."],
  "status": "QUEUED",
  "scheduledAt": null
}

Multiple groups at once

{
  "instanceId": "clxx...",
  "to": ["120363295648424210@g.us", "120363295648424211@g.us"],
  "type": "text",
  "payload": { "message": "Alert for several groups." }
}

3. Add or remove participants

POST /v1/whatsapp/instances/{instanceId}/groups/participants
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

Add

{
  "to": ["120363295648424210@g.us"],
  "action": "add",
  "participants": ["5511888888888", "5511777777777"]
}

Remove

{
  "to": ["120363295648424210@g.us"],
  "action": "remove",
  "participants": ["5511888888888"]
}

Response (200), example

{
  "success": true,
  "data": {
    "results": [
      { "groupJid": "120363295648424210@g.us", "success": true, "action": "add", "participantsCount": 2 }
    ]
  }
}

Your number must be group admin in WhatsApp. Otherwise the operation fails.

4. Send invite in DM

Sends the invite link to one or more individual numbers.

POST /v1/whatsapp/instances/{instanceId}/groups/invite
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "groups": ["120363295648424210@g.us"],
  "to": ["5511999999999"],
  "description": "Invite to the team group"
}

{
  "success": true,
  "data": {
    "results": [
      {
        "groupJid": "120363130091228687@g.us",
        "success": true,
        "data": {
          "send": true,
          "inviteUrl": "https://chat.whatsapp.com/EYkW0HWQLJ7CS82xdLIu4i"
        }
      }
    ]
  }
}

5. Revoke or fetch invite link

Revoke current link

POST /v1/whatsapp/instances/{instanceId}/groups/invite/revoke
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "groupJid": "120363295648424210@g.us"
}

Fetch current link or code

GET /v1/whatsapp/instances/{instanceId}/groups/invite-code?groupJid=120363295648424210@g.us
Authorization: Bearer sk_live_xxxxx

{
  "success": true,
  "data": {
    "inviteUrl": "https://chat.whatsapp.com/Gst4H0uNCjMFEwddWjWpm9",
    "inviteCode": "Gst4H0uNCjMFEwddWjWpm9"
  }
}

Important limits

Unofficial only, official instances return WHATSAPP_GROUPS_UNOFFICIAL_ONLY.
Does not create a brand-new group via API (use an existing group or create on phone first).
Adding people requires admin permission in WhatsApp.
List may return loading: true on first fetch, retry after a few seconds.
WhatsApp’s own rules still apply; the API does not replace app permissions.

Common errors

`code`	What to do
`SCOPE_GROUPS_REQUIRED`	Add `whatsapp:groups` to the key
`WHATSAPP_GROUPS_UNOFFICIAL_ONLY`	Use an unofficial instance
`loading: true` on list	Wait and call again

Full catalog: Error responses.

403: feature off or missing scope

Check that the instance is unofficial and the key has whatsapp:groups.

Failed to add/remove participant

Verify the instance number is admin of the group in the WhatsApp app.

Next steps

Connection modes: official × unofficial
WhatsApp, Introduction: instance, messages, webhooks
API Key scopes

​In brief

​When to use

​What you can do

Send to a group

List groups

Participants

Invites

​Before you start

​1. List groups

​Group participants

​2. Send a message to a group

​3. Add or remove participants

​4. Send invite in DM

​5. Revoke or fetch invite link

​Important limits

​Common errors

​Next steps

In brief

When to use

What you can do

Before you start

1. List groups

Group participants

2. Send a message to a group

3. Add or remove participants

4. Send invite in DM

5. Revoke or fetch invite link

Important limits

Common errors

Next steps