botapi

Use this method to change the description of a group

POST /setChatDescription

Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.

Body Required

  • chat_id string | integer Required

    Any of:
    string-2 string integer-1 integer

    Unique identifier for the target chat or username of the target channel (in the format @channelusername)

    Unique identifier for the target chat or username of the target channel (in the format @channelusername)

  • description string

    New chat description, 0-255 characters

Responses

  • default
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is false.

    • error_code integer Required
    • description string Required
    • parameters object

      Contains information about why a request was unsuccessful.

      Hide parameters attributes Show parameters attributes object
      • migrate_to_chat_id integer

        Optional. The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.

      • retry_after integer

        Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
  • 200
    Hide response attributes Show response attributes object
    • ok boolean Required

      Default value is true.

    • result boolean Required

      Default value is true.
POST /setChatDescription 
curl \
 -X POST https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/setChatDescription \
 -H "Content-Type: application/json" \
 -d '{"chat_id":42,"description":"string"}'
Request example 
{
  "chat_id": 42,
  "description": "string"
}
Request examples 
{
  "chat_id": "string",
  "description": "string"
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (default) 
{
  "ok": false,
  "error_code": 42,
  "description": "string",
  "parameters": {
    "migrate_to_chat_id": 42,
    "retry_after": 42
  }
}
Response examples (200) 
{
  "ok": true,
  "result": true
}
Response examples (200) 
{
  "ok": true,
  "result": true
}