# user.add

URL: https://chugunov.pro/api-bitrix24/user/user-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Пригласить пользователя
Scope: `user`
Кто может выполнять метод: администратор

## Описание

Метод `user.add` приглашает пользователя. Возможно только от имени пользователя с правами приглашения пользователей, как правило администратора. В случае успеха пользователю будет выслано стандартное приглашение на портал. В `result` возвращается идентификатор нового пользователя.

Если нужно добавить пользователя экстранета, то в полях необходимо передать: `EXTRANET: Y` и `SONET_GROUP_ID: [...]`. Если нужно добавить пользователя интранета, то **обязательно** передается: `UF_DEPARTMENT: [...]`.

## Параметры

- `EMAIL` `string` — обязательный. E-mail пользователя
- `NAME` `string` — необязательный. Имя
- `LAST_NAME` `string` — необязательный. Фамилия
- `SECOND_NAME` `string` — необязательный. Отчество
- `PERSONAL_GENDER` `string` — необязательный. Пол
- `PERSONAL_PROFESSION` `string` — необязательный. Профессия
- `PERSONAL_WWW` `string` — необязательный. Домашняя страничка
- `PERSONAL_BIRTHDAY` `string` — необязательный. Дата рождения
- `PERSONAL_PHOTO` `array` — необязательный. Фотография, передавайте массив из имени файла и строки с [Bаse64](https://apidocs.bitrix24.ru/api-reference/files/how-to-upload-files.html)
- `PERSONAL_ICQ` `string` — необязательный. ICQ
- `PERSONAL_PHONE` `string` — необязательный. Личный телефон
- `PERSONAL_FAX` `string` — необязательный. Факс
- `PERSONAL_MOBILE` `string` — необязательный. Личный мобильный
- `PERSONAL_PAGER` `string` — необязательный. Пейджер
- `PERSONAL_STREET` `string` — необязательный. Улица проживания
- `PERSONAL_CITY` `string` — необязательный. Город проживания
- `PERSONAL_STATE` `string` — необязательный. Область / край
- `PERSONAL_ZIP` `string` — необязательный. Почтовый индекс
- `PERSONAL_COUNTRY` `string` — необязательный. Страна
- `PERSONAL_MAILBOX` `string` — необязательный. Почтовый ящик
- `PERSONAL_NOTES` `string` — необязательный. Дополнительные заметки
- `WORK_PHONE` `string` — необязательный. Телефон компании
- `WORK_COMPANY` `string` — необязательный. Компания
- `WORK_POSITION` `string` — необязательный. Должность
- `WORK_DEPARTMENT` `string` — необязательный. Отдел
- `WORK_WWW` `string` — необязательный. Сайт компании
- `WORK_FAX` `string` — необязательный. WORK_FAX
- `WORK_PAGER` `string` — необязательный. WORK_PAGER
- `WORK_STREET` `string` — необязательный. WORK_STREET
- `WORK_MAILBOX` `string` — необязательный. WORK_MAILBOX
- `WORK_CITY` `string` — необязательный. Город работы
- `WORK_STATE` `string` — необязательный. WORK_STATE
- `WORK_ZIP` `string` — необязательный. WORK_ZIP
- `WORK_COUNTRY` `string` — необязательный. WORK_COUNTRY
- `WORK_PROFILE` `string` — необязательный. WORK_PROFILE
- `WORK_LOGO` `array` — необязательный. WORK_LOGO
- `WORK_NOTES` `string` — необязательный. WORK_NOTES
- `UF_SKYPE_LINK` `string` — необязательный. Ссылка на чат в Skype
- `UF_ZOOM` `string` — необязательный. Zoom
- `UF_DEPARTMENT` `string` — необязательный. Подразделения
- `UF_INTERESTS` `string` — необязательный. Интересы
- `UF_SKILLS` `string` — необязательный. Навыки
- `UF_WEB_SITES` `string` — необязательный. Другие сайты
- `UF_XING` `string` — необязательный. Xing
- `UF_LINKEDIN` `string` — необязательный. LinkedIn
- `UF_FACEBOOK` `string` — необязательный. Facebook**
- `UF_TWITTER` `string` — необязательный. Twitter
- `UF_SKYPE` `string` — необязательный. Skype
- `UF_DISTRICT` `string` — необязательный. Район
- `UF_PHONE_INNER` `string` — необязательный. Внутренний телефон

## Ответ

HTTP-статус: 200

```json
{
    "result":12,
    "time":{
        "start":1721733827.713938,
        "finish":1721733828.286292,
        "duration":0.5723540782928467,
        "processing":0.5508849620819092,
        "date_start":"2024-07-23T11:23:47+00:00",
        "date_finish":"2024-07-23T11:23:48+00:00",
        "operating":0.5508630275726318
    }
}
```

### Возвращаемые данные

- `result` `integer`. Идентификатор нового пользователя
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

HTTP-статус: 400

```json
{
    "error": "ERROR_ARGUMENT",
    "error_description": "wrong_email",
    "argument": ""
}
```

- `ERROR_ARGUMENT` — wrong_email. Не передан параметр `EMAIL` или передан некорректный e-mail
- `ERROR_ARGUMENT` — Пользователь с таким email уже существует. Попытка зарегистрировать пользователя на e-mail, который уже занят
- `ERROR_CORE` — access_denied. У пользователя нет прав на вызов метода
- `ERROR_ARGUMENT` — user_count_exceeded. Превышено количество пользователей
- `ERROR_GROUPID` — Не указан код группы. Не указан код группы при добавлении пользователя в экстранет
- `ERROR_NO_GROUP` — Группа указана неверно. Неверно указана группа при добавлении пользователя
- `ERROR_ARGUMENT` — no_extranet_field. При вызове метода не указано к какой группе должен принадлежать пользователь
- `ERROR_CORE` — . Ошибка обновления полей пользователя

## Примеры запроса

### cURL (Webhook)

```curl
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "EMAIL": "newuser1@example.com",
    "UF_DEPARTMENT": [1]
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.add
```

### cURL (OAuth)

```curl
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "EMAIL": "newuser1@example.com",
    "UF_DEPARTMENT": [1],
    "auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/user.add
```

### JS (TS)

```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: 'user.add',
    params: {
      EMAIL: 'newuser1@example.com',
      UF_DEPARTMENT: [1]
    },
    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('New user ID:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 addUser() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'user.add',
        params: {
          EMAIL: 'newuser1@example.com',
          UF_DEPARTMENT: [1]
        },
        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('New user ID:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.user.add(
        fields={
            "EMAIL": "newuser1@example.com",
            "UF_DEPARTMENT": [
                1,
            ],
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'user.add',
            [
                'EMAIL'        => 'newuser1@example.com',
                'UF_DEPARTMENT' => [1],
            ]
        );

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

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding user: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    "user.add",
    {
        "EMAIL": "newuser1@example.com",
        "UF_DEPARTMENT": [1]
    },
    function(result)
    {
        if(result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'user.add',
    [
        'EMAIL' => 'newuser1@example.com',
        'UF_DEPARTMENT' => [1]
    ]
);

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

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.add", b24.Params{
	"EMAIL":         "newuser1@example.com",
	"UF_DEPARTMENT": []int{1},
})
if err != nil {
	return fmt.Errorf("user.add: %w", err)
}

var newID b24.ID
if err := json.Unmarshal(res.Result, &newID); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("идентификатор:", newID)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/user/user-add.html