Skip to content

AddGroupParticipant#

Test Postman Apidog

The method adds a participant to a group chat.

Important

Only the administrator can add members, change the name and make other changes. If you are not the group administrator, the method will return an error.

Request#

To add a participant to a group chat, you have to execute a request at:

POST 
{{apiUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}

For apiUrl, idInstance and apiTokenInstance request parameters, refer to Before you start section.

Request parameters#

Parameter Type Mandatory Description
groupId string Yes Group chat Id
participantChatId string Yes Id of a participant added to a group chat.

Request body example#

Adding a participant to a group chat: 

{
    "groupId": "11001234567-1587570015@g.us",
    "participantChatId": "79001234565@c.us"
}

Response#

Response parameters#

Parameter Type Description
addParticipant boolean Flag indicating the addition of a participant to a group chat

Why is the request response false?

The response to the request or the value of addParticipant can be false for three reasons:

  1. The user attempting to add a new participant to the group does not have the status of an administrator for that group.
  2. The user adding a new participant to the group does not have the participant's number saved in their phonebook.
  3. The contact is already a member of the group.

While some numbers can be added to the group without being saved in the phonebook, it is recommended to always pre-save the participant's phone number in the contacts list to ensure successful addition to the group.

We also recommend reading the article "Why aren't members being added to the group?" for further details.

Response body example#

{
    "addParticipant": true
}

AddGroupParticipant errors#

For a list of errors common to all methods, refer to Common errors section

HTTP code Error iD Description
200 "addParticipant": false The number is already included in this group
200 "addParticipant": false Your number is not included in this group
200 "addParticipant": false Incorrect participantChatId
400 Bad Request
Validation failed		 Validation error

Request examples#

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}"

payload = {(
    "groupId": "11011234567@g.us", 
    "participantChatId":"79001234568@c.us")
}
headers = {
  'Content-Type': 'application/json'
}

response = requests.post(url, json=payload)

print(response.text.encode('utf8'))

curl --location '{{apiUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "groupId": "111111112222222333333@g.us",
    "participantChatId": "12345678910@c.us"
}'

var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/addGroupParticipant/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\"groupId\": \"111111112222222333333@g.us\",\"participantChatId\": \"12345678910@c.us\"}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);

var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/addGroupParticipant/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\"groupId\": \"111111112222222333333@g.us\",\"participantChatId\": \"12345678910@c.us\"}")
    .asString();

System.out.println(response);

Sub AddGroupParticipant()
    Dim url As String
    Dim RequestBody As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}"

    ' groupId - group chat identifier, participantChatId - identifier of the participant added to the group chat
    RequestBody = "{""groupId"":""120123400367448864@g.us"",""participantChatId"":""70123456789@c.us""}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    With http
        .Open "POST", url, False
        .setRequestHeader "Content-Type", "application/json"
        .Send RequestBody
    End With

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub