Exclude group member

Excludes a member from the group

Parameters

Function ExcludeGroupMember(Val AccessParameters, Val GroupID, Val UserID) Export

Parameter	CLI option	Type	Required	Description
AccessParameters	--access	Structure Of KeyAndValue	✔	Access parameters. See FormAccessParameters
GroupID	--group	String	✔	Group chat identifier
UserID	--user	String	✔	User ID to add

Returns

Map Of KeyAndValue - serialized JSON response from Green API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: RemoveGroupParticipant

1C:Enterprise/OneScript code example

    ApiUrl           = "https://7105.api.greenapi.com";
    MediaUrl         = "https://7105.media.greenapi.com";
    IdInstance       = "71051...";
    ApiTokenInstance = "425010d90e114aa6b78f0969e...";

    GroupID = "120363421084000163@g.us";
    UserID  = "123123123@c.us";

    AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenAPI.ExcludeGroupMember(AccessParameters, GroupID, UserID);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint greenapi ExcludeGroupMember \
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
      --group "120363426993098836@g.us" \
      --user "123123123@c.us"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint greenapi ExcludeGroupMember ^
      --access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
      --group "120363426993098836@g.us" ^
      --user "123123123@c.us"

Result

{
 "statusCode": 400,
 "timestamp": "2026-05-26T14:32:26.603Z",
 "path": "/waInstance7105187566/removeGroupParticipant/425010d90e114aa6b78f0969e1e67ec62579d30401c84d5183",
 "message": "Validation failed. Details: 'chatId': invalid phone number",
 "removeParticipant": true
}