im-chat-user-add.md

Invite Participants to Chat im.chat.user.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: chat participant with permission to add users to the chat

The method im.chat.user.add adds users to a chat.

Method Parameters

{% include Note on required parameters %}

#| || Name type | Description || || CHAT_ID* integer | Identifier of the chat.

The chat identifier can be obtained using the im.chat.get method || || USERS* array | Array of user identifiers to be added to the chat.

User identifiers can be obtained using the user.get and user.search methods || || HIDE_HISTORY string | Hide chat history for added users:

• Y — hide
• N — do not hide

Default: Y || |#

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,"USERS":[99,1271],"HIDE_HISTORY":"N"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.chat.user.add

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"CHAT_ID":2935,"USERS":[99,1271],"HIDE_HISTORY":"N","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/im.chat.user.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<boolean>({
      method: 'im.chat.user.add',
      params: {
        CHAT_ID: 2935,
        USERS: [99, 1271],
        HIDE_HISTORY: 'N',
      },
      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('Users added to chat:', 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 addChatUsers() {
      try {
        // Initialize the SDK inside a Bitrix24 frame
        const $b24 = await B24Js.initializeB24Frame()
  
        const response = await $b24.actions.v2.call.make({
          method: 'im.chat.user.add',
          params: {
            CHAT_ID: 2935,
            USERS: [99, 1271],
            HIDE_HISTORY: 'N',
          },
          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('Users added to chat:', result)
      } catch (error) {
        // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
        console.error(error)
      }
    }
  
    document.addEventListener('DOMContentLoaded', addChatUsers)
  </script>

• PHP

  try {
      $response = $b24Service
          ->core
          ->call(
              'im.chat.user.add',
              [
                  'CHAT_ID' => 2935,
                  'USERS' => [99, 1271],
                  'HIDE_HISTORY' => 'N'
              ]
          );
  
      $result = $response
          ->getResponseData()
          ->getResult();
  
      echo 'Success: ' . print_r($result, true);
      processData($result);
  
  } catch (Throwable $e) {
      error_log($e->getMessage());
      echo 'Error adding users to chat: ' . $e->getMessage();
  }

• BX24.js

  BX24.callMethod(
      'im.chat.user.add',
      {
          CHAT_ID: 2935,
          USERS: [99, 1271],
          HIDE_HISTORY: 'N'
      },
      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.user.add',
      [
          'CHAT_ID' => 2935,
          'USERS' => [99, 1271],
          'HIDE_HISTORY' => 'N'
      ]
  );
  
  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.user.add", b24.Params{
  	"CHAT_ID":      2935,
  	"USERS":        []int{99, 1271},
  	"HIDE_HISTORY": "N",
  })
  if err != nil {
  	return fmt.Errorf("im.chat.user.add: %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": 1772452546,
        "finish": 1772452546.179628,
        "duration": 0.1796278953552246,
        "processing": 0,
        "date_start": "2026-03-02T10:55:46+01:00",
        "date_finish": "2026-03-02T10:55:46+01:00",
        "operating_reset_at": 1772453146,
        "operating": 0.1326589584350586
    }
}

Returned Data

#| || Name type | Description || || result boolean | true if users were added to the chat || || time time | Information about the request execution time || |#

Error Handling

HTTP Status: 400, 403

{
    "error": "CHAT_ID_EMPTY",
    "error_description": "Chat ID 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 || || ACCESS_ERROR | Action unavailable | Operation not available for this chat || || ACCESS_ERROR | It is forbidden to add users to this chat | Users cannot be added to this chat || || ACCESS_DENIED_EXTEND | Insufficient permissions to add participants to the chat | Not enough permissions to add participants to the chat || |#

{% include system errors %}

Continue Learning

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