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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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 -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
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type UserUpdateResult = boolean

try {
  const response = await $b24.actions.v2.call.make<UserUpdateResult>({
    method: 'user.update',
    params: {
      ID: 1,
      NAME: 'Administrator',
      LAST_NAME: 'SomeLastName',
    },
    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('User updated successfully:', result)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<!-- 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 updateUser() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'user.update',
        params: {
          ID: 1,
          NAME: 'Administrator',
          LAST_NAME: 'SomeLastName',
        },
        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('User updated successfully:', result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateUser)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.user.update(
        fields={
            "ID": 1,
            "NAME": "Administrator",
            "LAST_NAME": "SomeLastName",
        },
    ).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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "user.update", b24.Params{
	"ID":        1,
	"NAME":      "Administrator",
	"LAST_NAME": "SomeLastName",
})
if err != nil {
	return fmt.Errorf("user.update: %w", err)
}

var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)

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

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
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

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

Код

Cообщение об ошибке

Описание

ERROR_CORE

access_denied

Передан неверный ID пользователя

ERROR_CORE

access_denied

У пользователя нет прав на вызов метода

ERROR_CORE

Передан неверный ID пользователя

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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