Skip to main content
POST
/
group
/
updateParticipant
/
:instanceName
curl --request POST \
  --url https://api.example.com/group/updateParticipant/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupJid": "[email protected]",
    "action": "add",
    "participants": [
      "5511999999999",
      "5511888888888"
    ]
  }'

{
  "success": true,
  "action": "add",
  "participants": [
    "[email protected]",
    "[email protected]"
  ],
  "results": [
    {
      "jid": "[email protected]",
      "status": "success",
      "message": "Participant added successfully"
    },
    {
      "jid": "[email protected]",
      "status": "success",
      "message": "Participant added successfully"
    }
  ]
}

​
Overview

You can manage group participants by adding new members, removing existing ones, or changing their admin status. You must be a group admin to perform these actions.
Only group admins can add, remove, promote, or demote participants. Attempting these actions as a regular member will fail.

​
Authentication

This endpoint requires authentication via the apikey header.
​
header.apikey
string
required
Your Evolution API key for authentication.

​
Path Parameters

​
path.instanceName
string
required
The name of your WhatsApp instance.

​
Request Body

​
groupJid
string
required
The WhatsApp group JID (can be provided with or without the @g.us suffix).
​
action
string
required
The action to perform on participants. Must be one of:
  • add: Add new participants to the group
  • remove: Remove participants from the group
  • promote: Promote participants to admin status
  • demote: Demote admins to regular member status
​
participants
string[]
required
Array of participant phone numbers in international format (e.g., [“5511999999999”, “5511888888888”]).

​
Response

​
success
boolean
Whether the operation completed successfully.
​
action
string
The action that was performed.
​
participants
array
Array of affected participant JIDs.
​
results
array
Detailed results for each participant.
curl --request POST \
  --url https://api.example.com/group/updateParticipant/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "groupJid": "[email protected]",
    "action": "add",
    "participants": [
      "5511999999999",
      "5511888888888"
    ]
  }'

{
  "success": true,
  "action": "add",
  "participants": [
    "[email protected]",
    "[email protected]"
  ],
  "results": [
    {
      "jid": "[email protected]",
      "status": "success",
      "message": "Participant added successfully"
    },
    {
      "jid": "[email protected]",
      "status": "success",
      "message": "Participant added successfully"
    }
  ]
}

​
Usage Notes

When adding participants, they will receive a group invitation notification. If their privacy settings prevent group adds, they’ll need to join manually using an invite link.
You can add multiple participants in a single request. The response will include individual status for each participant.
Super admins (group creators) cannot be demoted or removed through this endpoint.

​
Additional Endpoints

​
Get Participants List

To retrieve the list of group participants: 
GET /group/participants/:[email protected]
This returns an array of participant objects with their admin status.

Build docs developers (and LLMs) love

Get started for freeTalk to us