Skip to main content

Leave group

Excludes the current account from the specified group

Function LeaveGroup(Val AccessParameters, Val ChatID) Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValueAccess parameters. See FormAccessParameters
ChatID--chatStringGroup chat ID

Returns: Map Of KeyAndValue - serialized JSON response from Green API


tip

Method at API documentation: LeaveGroup


1C:Enterprise/OneScript code example
    ApiUrl           = "https://3100.api.green-api.com/v3";
MediaUrl = "https://3100.api.green-api.com/v3";
IdInstance = "31003...";
ApiTokenInstance = "17915d8e0b4b4975a183478da...";

ChatID = 12345678;
AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenMax.LeaveGroup(AccessParameters, ChatID);
    # JSON data can also be passed as a path to a .json file

oint greenmax LeaveGroup \
--access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
--chat "-68929077051477"
Result
{
"leaveGroup": true
}