im-chat-update-title.md

Update Chat Title im.chat.updateTitle

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

Scope: im

Who can execute the method: chat participant with permission to change the appearance

The method im.chat.updateTitle updates the chat title.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || CHAT_ID* integer | Chat identifier. Pass a number without the chat prefix. Required if DIALOG_ID is not provided.

The chat identifier can be obtained using the im.chat.get method. || || DIALOG_ID string | Identifier of the dialog in the format chatXXX, where XXX is the chat identifier. Can be provided instead of CHAT_ID.

The method works only with group chats: for a private dialog it returns the DIALOG_ID_EMPTY error || || TITLE* string | Chat title.

The value is automatically trimmed of whitespace and line breaks. || |#

Code Examples

{% include Note on examples %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":2935,"TITLE":"Project Chat"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.updateTitle

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":2935,"TITLE":"Project Chat","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.chat.updateTitle

• JS (TS)

  // This snippet is an ES module: top-level await requires type="module" or a bundler.
  // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
  import { Text } from '@bitrix24/b24jssdk'
  import type { B24Frame } from '@bitrix24/b24jssdk'
  
  declare const $b24: B24Frame
  
  try {
    const response = await $b24.actions.v2.call.make<boolean>({
      method: 'im.chat.updateTitle',
      params: {
        CHAT_ID: 2935,
        TITLE: 'Project Chat',
      },
      requestId: Text.getUuidRfc4122()
    })
  
    // The payload is available only on a successful response
    if (!response.isSuccess) {
      console.error(response.getErrorMessages().join('; '))
    } else {
      const result = response.getData()!.result
      console.info('Chat title updated:', result)
    }
  } catch (error) {
    // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
    console.error(error)
  }

• JS (UMD)

  <!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
  <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
  <script>
    async function updateChatTitle() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'im.chat.updateTitle',
          params: {
            CHAT_ID: 2935,
            TITLE: 'Project Chat',
          },
          requestId: B24Js.Text.getUuidRfc4122()
        })
  
        // The payload is available only on a successful response
        if (!response.isSuccess) {
          console.error(response.getErrorMessages().join('; '))
          return
        }
  
        const result = response.getData().result
        console.info('Chat title updated:', result)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', updateChatTitle)
  </script>

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'im.chat.updateTitle',
              [
                  'CHAT_ID' => 2935,
                  'TITLE' => 'Project Chat'
              ]
          );
  
      $result = $response
          ->getResponseData()
          ->getResult();
  
      echo 'Success: ' . print_r($result, true);
      processData($result);
  
  } catch (Throwable $e) {
      error_log($e->getMessage());
      echo 'Error updating chat title: ' . $e->getMessage();
  }

• BX24.js

  BX24.callMethod(
      'im.chat.updateTitle',
      {
          CHAT_ID: 2935,
          TITLE: 'Project Chat',
      },
      function(result)
      {
          if (result.error())
          {
              console.error(result.error());
          }
          else
          {
              console.log(result.data());
          }
      }
  );

• PHP CRest

  require_once('crest.php');
  
  $result = CRest::call(
      'im.chat.updateTitle',
      [
          'CHAT_ID' => 2935,
          'TITLE' => 'Project Chat'
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

• Go

  // client and ctx are already created — see the Go SDK section
  res, err := client.Core().Call(ctx, "im.chat.updateTitle", b24.Params{
  	"CHAT_ID": 2935,
  	"TITLE":   "Project Chat",
  })
  if err != nil {
  	return fmt.Errorf("im.chat.updateTitle: %w", err)
  }
  
  var ok bool
  if err := json.Unmarshal(res.Result, &ok); err != nil {
  	return fmt.Errorf("parse response: %w", err)
  }
  fmt.Println("done:", ok)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": true,
    "time": {
        "start": 1772461866,
        "finish": 1772461866.894201,
        "duration": 0.8942010402679443,
        "processing": 0,
        "date_start": "2026-03-02T15:31:06+01:00",
        "date_finish": "2026-03-02T15:31:06+01:00",
        "operating_reset_at": 1772462466,
        "operating": 0.11278390884399414
    }
}

Returned Data

#| || Name type | Description || || result boolean | true if the chat title was updated. || || time time | Information about the request execution time. || |#

Error Handling

HTTP Status: 400, 403

{
    "error": "TITLE_EMPTY",
    "error_description": "Title can't be empty"
}

{% include notitle error handling %}

Possible Error Codes

#| || Code | Description | Value || || CHAT_ID_EMPTY | Chat ID can't be empty | CHAT_ID not provided, or the value contains the chat prefix. || || DIALOG_ID_EMPTY | Dialog ID can't be empty | A private dialog or an invalid format was provided in DIALOG_ID. || || TITLE_EMPTY | Title can't be empty | TITLE not provided or empty after trimming. || || ACCESS_ERROR | Action unavailable | Operation not available for this chat. || || ACCESS_ERROR | This chat cannot be renamed | This chat cannot be renamed. || |#

{% include system errors %}

Continue Learning

• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}
• {#T}