POST
/
group-management
/
{accountId}
curl --request POST \
  --url https://api.a1base.com/v1/group-management/{accountId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'X-API-Secret: <api-key>' \
  --data '{
  "action": "create",
  "agent_number": "<string>",
  "thread_id": "<string>",
  "title": "<string>",
  "participants": [
    "<string>"
  ],
  "initial_message": "<string>",
  "name": "<string>",
  "description": "<string>",
  "image_url": "<string>",
  "invite_code": "<string>",
  "setting": "announcement"
}'
{
  "status": "success",
  "message": "<string>",
  "data": {
    "thread_id": "<string>",
    "title": "<string>",
    "participants": [
      "<string>"
    ]
  }
}

The group management endpoint allows you to perform various WhatsApp group operations including creating groups, managing participants, and updating group settings.

​
Key Operations:

  • Create new groups with specified participants
  • Update group details (name, description, picture)
  • Manage participants (add, remove, promote/demote admins)
  • Handle group invites and messaging permissions

​
Example Request

curl --location 'https://api.a1base.com/v1/whatsapp/{accountId}/group-management' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'x-api-secret: YOUR_API_SECRET' \
--header 'Content-Type: application/json' \
--data '{
    "action": "create",
    "agent_number": "+1234567890",
    "title": "New Group",
    "participants": ["+1987654321"]
}'

​
Request Body

​
action
string
required

The operation to perform. Valid values:

  • create
  • update_name
  • update_description
  • update_picture
  • add_participants
  • remove_participants
  • promote_admin
  • demote_admin
  • join
  • leave
  • update_settings
​
agent_number
string
required

The phone number initiating the action (must start with ’+’)

​
thread_id
string

The group chat ID. Required for all actions except ‘create’

​
Action-Specific Fields

​
Example Requests

Authorizations

​
X-API-Key
string
header
required
​
X-API-Secret
string
header
required

Headers

​
X-API-Key
string
required
​
X-API-Secret
string
required

Path Parameters

​
accountId
string
required

Body

application/json
​
action
enum<string>
required

The operation to perform

Available options:
create,
update_name,
update_description,
update_picture,
add_participants,
remove_participants,
promote_admin,
demote_admin,
join,
leave,
update_settings
​
agent_number
string
required

The phone number initiating the action (must start with '+')

​
thread_id
string

The group chat ID (required for all actions except 'create')

​
title
string

Group name (for create action)

​
participants
string[]

Phone numbers to add/remove/modify

​
initial_message
string

First message to send (optional, for create action)

​
name
string

New group name (for update_name action)

​
description
string

New description (for update_description action)

​
image_url
string

New profile picture URL (for update_picture action)

​
invite_code
string

Group invite code (for join action)

​
setting
enum<string>

Group setting to update (for update_settings action)

Available options:
announcement,
not_announcement,
locked,
unlocked

Response

200
application/json
Operation completed successfully
​
status
enum<string>
Available options:
success
​
message
string
​
data
object