Skip to main content

Change group settings

Changes selected group chat settings

Function ChangeGroupSettings(Val AccessParameters, Val ChatID, Val Settings) Export

ParameterCLI optionTypeRequiredDescription
AccessParameters--accessStructure Of KeyAndValue✔Access parameters. See FormAccessParameters
ChatID--chatString✔Group chat ID
Settings--setStructure Of KeyAndValue✔Group chat settings. See GetGroupSettingsStructure

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


tip

Method at API documentation: UpdateGroupSettings


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;
    Settings = New Structure;
    Settings.Insert("allowParticipantsEditGroupSettings" , True);
    Settings.Insert("allowParticipantsPinMessages"       , False);
    Settings.Insert("allowParticipantsAddMembers"        , False);

    AccessParameters = OPI_GreenMax.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
    Result           = OPI_GreenMax.ChangeGroupSettings(AccessParameters, ChatID, Settings);
    # JSON data can also be passed as a path to a .json file
    
    oint greenmax ChangeGroupSettings \
     --access "{'apiUrl':'***','mediaUrl':'https://3100.api.green-api.com/v3','idInstance':'3100309139','apiTokenInstance':'***'}" \
     --chat "-68929070366805" \
     --set "{'allowParticipantsEditGroupSettings':true,'allowParticipantsPinMessages':false,'allowParticipantsAddMembers':false}"
Result
{
 "updateGroupSettings": true
}