Update group name
Changes the name of an existing group
- Parameters
- Advanced call ?
Function UpdateGroupName(Val AccessParameters, Val GroupID, Val Name) Export
| Parameter | CLI option | Type | Required | Description |
|---|---|---|---|---|
| AccessParameters | --access | Structure Of KeyAndValue | ✔ | Access parameters. See FormAccessParameters |
| GroupID | --group | String | ✔ | Group chat identifier |
| Name | --name | String | ✔ | New group chat name |
Returns
Map Of KeyAndValue - serialized JSON response from Green API
| 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: UpdateGroupName
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";
Name = "New name";
AccessParameters = OPI_GreenAPI.FormAccessParameters(ApiUrl, MediaUrl, IdInstance, ApiTokenInstance);
Result = OPI_GreenAPI.UpdateGroupName(AccessParameters, GroupID, Name);
- Bash
- CMD/Bat
# JSON data can also be passed as a path to a .json file
oint greenapi UpdateGroupName \
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" \
--group "120363426993098836@g.us" \
--name "New name"
:: JSON data can also be passed as a path to a .json file
oint greenapi UpdateGroupName ^
--access "{'apiUrl':'***','mediaUrl':'https://7105.media.greenapi.com','idInstance':'7105187566','apiTokenInstance':'***'}" ^
--group "120363426993098836@g.us" ^
--name "New name"
Result
{
"updateGroupName": true
}