botapi

Use this method to set a custom title for an administrator in a supergroup promoted by the bot

POST /setChatAdministratorCustomTitle

Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.

Body Required

  • chat_id integer | string Required

    Any of:
    integer-1 integer string-2 string

    Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

    Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)

  • user_id integer Required

    Unique identifier of the target user

  • custom_title string Required

    New custom title for the administrator; 0-16 characters, emoji are not allowed

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 /setChatAdministratorCustomTitle 
curl \
 -X POST https://api.telegram.org/bot123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11/setChatAdministratorCustomTitle \
 -H "Content-Type: application/json" \
 -d '{"chat_id":42,"user_id":42,"custom_title":"string"}'
Request example 
{
  "chat_id": 42,
  "user_id": 42,
  "custom_title": "string"
}
Request examples 
{
  "chat_id": 42,
  "user_id": 42,
  "custom_title": "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
}