This page covers the methods for creating and editing WhatsApp group chats via the API, as well as retrieving information about groups. Learn more about how group chats work in Wazzup by referring to our guide.
When using the methods listed below, include the end‑customer's client_access_token (obtained via simplified authorization or OAuth) in the request header: Authorization: Bearer client_access_token
Use this method to create a new WhatsApp group and add members to it.
If any of the contacts have disabled the option to be added to group chats in their messenger settings, they will receive an invitation to join the group instead.
POST /v2/groups| Body parameter. Required marked with * | Type | Description |
channel_id * |
string |
Unique channel identifier |
type * |
string |
Group type: whatsapp |
name * |
string |
Group name (1–100 characters) |
avatar_url |
string |
Group avatar image |
members * |
array |
List of group participants |
members.phone * |
string |
Participant's phone number (minimum 1 character) |
members.name |
string |
Participant's name (up to 150 characters) |
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups' \
-H 'Authorization: Bearer <client_access_token>'
{
"channel_id": "87d624ba-1cca-4ae3-a348-2dc0b56b8930",
"type": "whatsapp",
"name": "New group",
"avatar_url": "https://example.com/avatar.jpg",
"members": [
{
"phone": "+37191512312",
"name": "John"
}
]
}
Response example:
{
"data": {
"group_id": "e0de64bf-05b5-412a-a8bc-183acc307b",
"name": "New group",
"avatar_url": "https://example.com/group-avatar.jpg",
"has_settings_access": true,
"members": [
{
"group_member_id": "044e21af-bab4-473c-9fb6-9b3d08023721",
"name": "John",
"avatar_url": "https://example.com/avatar1.jpg",
"is_admin": false,
"status": "in_group",
"is_you": true
}
]
},
"meta": {
"timestamp": 1762372409
}
}
Result: Returns information about the group chat that has been just created.
data
├── group_id *
├── name *
├── avatar_url
├── has_settings_access *
└── members *
├── name *
├── avatar_url
├── is_admin *
├── status *
└── is_you *
| Response parameter. Required marked with * | Type | Description |
group_id * |
string |
Group chat identifier |
name * |
string |
Group chat name |
avatar_url |
string |
Link to the group avatar |
has_settings_access * |
boolean |
If true, group settings are accessible |
members * |
object members |
Object containing participant information |
| Response parameter. Required marked with * | Type | Description |
name * |
string |
Participant name |
avatar_url |
string |
Link to the participant's avatar |
is_admin * |
boolean |
Indicates whether the participant is a group admin |
status * |
string |
Participant status: invited, in_group, unknown, deleted, not_exists |
is_you * |
boolean |
true if the participant is the channel connected to the Wazzup account |
This method returns information about a group. You can also subscribe to webhooks to receive real‑time updates about changes in group chats.
GET /v2/groups/{group_id}Path parametersgroup_id — Group chat ID
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups/e0de64bf-05b5-412a-a8bc-183acc307b' -H 'Authorization: Bearer <client_access_token>'
Response example:
{
"data": {
"name": "New group",
"avatar_url": "https://example.com/group-avatar.jpg",
"has_settings_access": true,
"members": [
{
"group_member_id": "813e884b-617c-4c17-ae8d-ba2fd0c0cb6e",
"name": "John",
"avatar_url": "https://example.com/avatar1.jpg",
"is_admin": false,
"status": "in_group",
"is_you": true
}
]
},
"meta": {
"timestamp": 1762372409
}
}
Result: Returns information about the group chat.
PATCH /v2/groups/{group_id}Path parametersgroup_id — Group chat ID
| Request parameter. Required marked with * | Type | Description |
name * |
string |
Group name (1–100 characters) |
avatar_url |
string |
Group avatar image |
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups/e0de64bf-05b5-412a-a8bc-183acc307b' \
-H 'Authorization: Bearer <client_access_token>'
{
"name": "Group",
"avatar_url": "https://example.com/avatar.jpg"
}
Response example:
{
"data": null,
"meta": {
"timestamp": 1762372409
}
}
Result: The group chat information has been updated.
POST /v2/groups/{group_id}/membersPath parametersgroup_id — Group chat ID
| Request parameter. Required marked with * | Type | Description |
phone * |
string |
Participant's phone number (minimum 1 character) |
name |
string |
Participant's name (up to 150 characters) |
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups/e0de64bf-05b5-412a-a8bc-183acc307b' \
-H 'Authorization: Bearer <client_access_token>'
[
{
"phone": "+37191512312",
"name": "John"
}
]
Response example:
{
"data": [
{
"group_member_id": "d1b504f7-2202-42c5-a799-b019f6485",
"name": "John",
"avatar_url": "https://example.com/avatar1.jpg",
"is_admin": false,
"status": "in_group",
"is_you": true
}
],
"meta": {
"timestamp": 1762372409
}
}
Result: A new participant has been added to the group.
DELETE /v2/groups/{group_id}/membersPath parametersgroup_id — Group chat ID
Request parametersgroup_member_id — Participant ID. This is returned when creating a group, adding a participant, or requesting group information.
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups/e0de4bf-05b5-412a-a8bc-183ac307b' \
-H 'Authorization: Bearer <client_access_token>'
[
{
"group_member_id": "579cfe-a27d-48d0-934a-a2e1e37de634"
}
]
Response example:
{
"data": null,
"meta": {
"timestamp": 1762372409
}
}
Result: The participant has been removed from the group.
In Wazzup, you can rename a group chat participant to make it easier for users to identify who they're communicating with. For example, you could rename a participant from "Alex" to "Alex — Accountant." This change only affects how the participant's name appears within the Wazzup group chat; their name in the messenger remains unchanged.
PATCH /v2/groups/{group_id}/membersPath parametersgroup_id — Group chat ID
| Request parameter. Required marked with * | Type | Description |
group_member_id * |
string |
Participant ID. This is returned when creating a group, adding a participant, or requesting group information |
name |
string |
New participant name (up to 150 characters) |
Request example:
curl -L 'https://tech.wazzup24.com/v2/groups/e064bf-05b5-412a-a8bc-183acc307b' \
-H 'Authorization: Bearer <client_access_token>'
[
{
"group_member_id": "8bd17f-c415-4bf7-93db-a4098e8de7b9",
"name": "John"
}
]
Response example:
{
"data": null,
"meta": {
"timestamp": 1762372409
}
}
Result: The group participant has been renamed.