OpenIntegrations/docs/en/md/VKTeams/Chat-management/Set-chat-description.md

sidebar_position

sidebar_position
13

Set chat description

Sets new chat description

Function SetChatDescription(Val Token, Val ChatID, Val Text) Export

Parameter	CLI option	Type	Description
Token	--token	String	Bot token
ChatID	--chatid	String, Number	Chat ID
Text	--text	String	Description text

Returns: Map Of KeyAndValue - Serialized JSON response from VK Teams

:::tip To call this method, the bot must be an administrator in the chat room.

Method at API documentation: GET ​​/chats/setAbout :::

    Token  = "001.3501506236.091...";
    ChatID = "689203963@chat.agent";
    Text   = "New description";

    Result = OPI_VKTeams.SetChatDescription(Token, ChatID, Text);

    
  oint vkteams SetChatDescription --token "001.3501506236.091..." --chatid "689203963@chat.agent" --text %text%

{
 "ok": true
}