Create Chat im.chat.add

{% 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: any user

The method im.chat.add creates a new chat.

Method Parameters

{% include Note on required parameters %}

The method has no required parameters: without any parameters it creates a closed chat with an automatically generated title, where the current user is the only participant and the owner.

#| || Name type | Description || || USERS array | An array of user IDs to be added to the chat.

The chat Creator is automatically added to the chat as the Owner || || TYPE string | Type of chat:

OPEN — open chat
CHAT — closed chat

By default, a closed chat CHAT is created || || TITLE string | Title of the chat.

If the parameter is not provided, the title will be automatically generated using the template #COLOR# chat №#NUMBER# or Chat with #USERS_NAMES# || || DESCRIPTION string | Description of the chat || || COLOR string | Color of the chat. Possible values:

RED — red
GREEN — green
MINT — mint
LIGHT_BLUE — light blue
DARK_BLUE — dark blue
PURPLE — purple
AQUA — aqua
PINK — pink
LIME — lime
BROWN — brown
AZURE — azure
KHAKI — khaki
SAND — sand
MARENGO — marengo
GRAY — gray
GRAPHITE — graphite || || MESSAGE string | The first message in the chat || || AVATAR string | Avatar of the chat in base64 string format.

Maximum image size is 5000x5000.

{% note tip "Typical use-cases and scenarios" %}

How to upload files

{% endnote %}

|| || ENTITY_TYPE string | Type of object to link the chat with external context.

Possible values:

VIDEOCONF — video conference chat
AI_ASSISTANT_PRIVATE — private chat with AI assistant
LINES — open line chat from the operator's side
LIVECHAT — open line chat from the client's side
ANNOUNCEMENT — announcement chat
CALENDAR — chat related to a calendar event
MAIL — chat related to email correspondence
CRM — chat related to a CRM object
SONET_GROUP — social network group chat
TASKS — chat related to a task
CALL — chat related to a call

|| || ENTITY_ID string | Identifier of the object within ENTITY_TYPE.

Passed as a string. The format depends on the selected ENTITY_TYPE.

Supported formats for common types:

CRM — <CRM_TYPE>|<ID>, for example LEAD|13, DEAL|1663, CONTACT|25, COMPANY|7. For smart processes — DYNAMIC_<entityTypeId>|<itemId>
LINES — <connectorId>|<lineId>|<connectorChatId>|<connectorUserId>, for example telegrambot|2|209607941|744
LIVECHAT — <connectorId>|<lineId>
TASKS — task identifier, for example 8293
CALENDAR — calendar event identifier
SONET_GROUP — group identifier

For other ENTITY_TYPE, the format is defined by the module or integration. It can be an arbitrary string.

When creating a chat, you can pass any pair of ENTITY_TYPE and ENTITY_ID. The method get chat identifier will return the chat if called with the same pair of values || || COPILOT_MAIN_ROLE string | Code of the main role for BitrixGPT.

Possible values:

copilot_assistant — universal default role
any code of an available BitrixGPT role from the AI library || |#

Code Examples

{% include Example Note %}

{% list tabs %}

cURL (Webhook)

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Deal Chat","DESCRIPTION":"Discussing the deal here","COLOR":"PINK","MESSAGE":"Welcome to the deal chat","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.add

cURL (OAuth)

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"USERS":[103, 547],"TYPE":"CHAT","TITLE":"Deal Chat","DESCRIPTION":"Discussing the deal here","COLOR":"PINK","MESSAGE":"Welcome to the deal chat","ENTITY_TYPE":"CRM","ENTITY_ID":"DEAL|1663","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.chat.add

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<number>({
    method: 'im.chat.add',
    params: {
      USERS: [103, 547],
      TYPE: 'CHAT',
      TITLE: 'Chat about deal',
      DESCRIPTION: 'Discuss the deal here',
      COLOR: 'PINK',
      MESSAGE: 'Welcome to the deal chat',
      ENTITY_TYPE: 'CRM',
      ENTITY_ID: 'DEAL|1663',
    },
    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('Created chat ID:', 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 createChat() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'im.chat.add',
        params: {
          USERS: [103, 547],
          TYPE: 'CHAT',
          TITLE: 'Chat about deal',
          DESCRIPTION: 'Discuss the deal here',
          COLOR: 'PINK',
          MESSAGE: 'Welcome to the deal chat',
          ENTITY_TYPE: 'CRM',
          ENTITY_ID: 'DEAL|1663',
        },
        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('Created chat ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', createChat)
</script>

PHP

try {
    $response = $b24Service
        ->core
        ->call(
            'im.chat.add',
            [
                'USERS' => [103, 547],
                'TYPE' => 'CHAT',
                'TITLE' => 'Deal Chat',
                'DESCRIPTION' => 'Discussing the deal here',
                'COLOR' => 'PINK',
                'MESSAGE' => 'Welcome to the deal chat',
                'ENTITY_TYPE' => 'CRM',
                'ENTITY_ID' => 'DEAL|1663',
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'CHAT_ID: ' . $result;
} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

BX24.js

BX24.callMethod(
    'im.chat.add',
    {
        USERS: [103, 547],
        TYPE: 'CHAT',
        TITLE: 'Deal Chat',
        DESCRIPTION: 'Discussing the deal here',
        COLOR: 'PINK',
        MESSAGE: 'Welcome to the deal chat',
        ENTITY_TYPE: 'CRM',
        ENTITY_ID: 'DEAL|1663',
    },
    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.add',
    [
        'USERS' => [103, 547],
        'TYPE' => 'CHAT',
        'TITLE' => 'Deal Chat',
        'DESCRIPTION' => 'Discussing the deal here',
        'COLOR' => 'PINK',
        'MESSAGE' => 'Welcome to the deal chat',
        'ENTITY_TYPE' => 'CRM',
        'ENTITY_ID' => 'DEAL|1663',
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "im.chat.add", b24.Params{
	"USERS":       []int{103, 547},
	"TYPE":        "CHAT",
	"TITLE":       "Deal Chat",
	"DESCRIPTION": "Discussing the deal here",
	"COLOR":       "PINK",
	"MESSAGE":     "Welcome to the deal chat",
	"ENTITY_TYPE": "CRM",
	"ENTITY_ID":   "DEAL|1663",
})
if err != nil {
	return fmt.Errorf("im.chat.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("parse response: %w", err)
}
fmt.Println("id:", newID)

{% endlist %}

Response Handling

HTTP Status: 200

{
    "result": 1417,
    "time": {
        "start": 1772009915,
        "finish": 1772009915.872788,
        "duration": 0.8727879524230957,
        "processing": 0,
        "date_start": "2026-02-25T11:58:35+01:00",
        "date_finish": "2026-02-25T11:58:35+01:00",
        "operating_reset_at": 1772010515,
        "operating": 0.20950984954833984
    }
}

Returned Data

#| || Name type | Description || || result integer | Identifier of the created chat || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 401

{
    "error": "INVALID_CREDENTIALS",
    "error_description": "Invalid request credentials"
}

The method has no error codes of its own — only system REST API errors are possible.

{% include notitle error handling %}

{% include system errors %}

Navigation Menu

Uh oh!

Create Chat im.chat.add

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Continue Learning

Uh oh!

FilesExpand file tree

im-chat-add.md

Latest commit

History

im-chat-add.md

File metadata and controls

Create Chat im.chat.add

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Continue Learning