Обновить данные пользователя user.update

Scope: user

Кто может выполнять метод: администратор

Метод user.update обновляет данные пользователя. Возможно только от имени пользователя с правами приглашения пользователей.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
ID* `integer`	Идентификатор пользователя
ACTIVE `boolean`	Признак активности пользователя. Возможные значения: `Y` — сотрудник активен, `N` — сотрудник уволен
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
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`	Внутренний телефон

*Принадлежит компании Meta Platforms, Inc., которая признана экстремистской и запрещена на территории Российской Федерации.

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "ID": 1,
            "NAME": "Administrator",
            "LAST_NAME": "SomeLastName"
        }' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/user.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{
            "ID": 1,
            "NAME": "Administrator",
            "LAST_NAME": "SomeLastName",
            "auth": "**put_access_token_here**"
        }' \
        https://**put_your_bitrix24_address**/rest/user.update

try
        {
        	const response = await $b24.callMethod(
        		"user.update",
        		{
        			"ID": 1,
        			"NAME": "Administrator",
        			"LAST_NAME": "SomeLastName"
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'user.update',
                    [
                        'ID'       => 1,
                        'NAME'     => 'Administrator',
                        'LAST_NAME' => 'SomeLastName',
                    ]
                );
        
            $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 updating user: ' . $e->getMessage();
        }

BX24.callMethod(
            "user.update",
            {
                "ID": 1,
                "NAME": "Administrator",
                "LAST_NAME": "SomeLastName"
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'user.update',
            [
                'ID' => 1,
                'NAME' => 'Administrator',
                'LAST_NAME' => 'SomeLastName'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

    {
                "result": true,
                "time": {
                    "start": 1721807581.02493,
                    "finish": 1721807581.20039,
                    "duration": 0.17546010017395,
                    "processing": 0.133708000183105,
                    "date_start": "2024-07-24T07:53:01+00:00",
                    "date_finish": "2024-07-24T07:53:01+00:00",
                    "operating": 0.133685827255249
                }
            }

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

Название `тип`	Описание
result `boolean`	Успешность выполнения
time `time`	Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "ERROR_CORE",
            "error_description": "access_denied"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Cообщение об ошибке	Описание
`ERROR_CORE`	access_denied	Передан неверный `ID` пользователя
`ERROR_CORE`	access_denied	У пользователя нет прав на вызов метода
`ERROR_CORE`		Передан неверный `ID` пользователя

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Пригласить пользователя

Получить информацию о текущем пользователе

Обновить данные пользователя user.update

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение