Update user data user.update

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: user

Who can execute the method: administrator

The user.update method updates user data. This is only possible on behalf of a user with user invitation rights.

Method Parameters

Required parameters are marked with *

Name
type

Description

ID*
integer

User identifier

ACTIVE
boolean

User activity flag. Possible values:

  • Y — employee is active,
  • N — employee is dismissed

EMAIL
string

User E-mail

NAME
string

First name

LAST_NAME
string

Last name

SECOND_NAME
string

Middle name

PERSONAL_GENDER
string

Gender

PERSONAL_PROFESSION
string

Profession

PERSONAL_WWW
string

Homepage

PERSONAL_BIRTHDAY
string

Date of birth

PERSONAL_PHOTO
array

Photo, pass an array containing the file name and a Base64 string

PERSONAL_ICQ
string

ICQ

PERSONAL_PHONE
string

Personal phone

PERSONAL_FAX
string

Fax

PERSONAL_MOBILE
string

Personal mobile

PERSONAL_PAGER
string

Pager

PERSONAL_STREET
string

Residential street

PERSONAL_CITY
string

Residential city

PERSONAL_STATE
string

Region / territory

PERSONAL_ZIP
string

Postal code

PERSONAL_COUNTRY
string

Country

PERSONAL_MAILBOX
string

P.O. Box

PERSONAL_NOTES
string

Additional notes

WORK_PHONE
string

Company phone

WORK_COMPANY
string

Company

WORK_POSITION
string

Job title

WORK_DEPARTMENT
string

Department

WORK_WWW
string

Company website

WORK_FAX
string

WORK_FAX

WORK_PAGER
string

WORK_PAGER

WORK_STREET
string

WORK_STREET

WORK_MAILBOX
string

WORK_MAILBOX

WORK_CITY
string

Work city

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 chat link

UF_ZOOM
string

Zoom

UF_DEPARTMENT
string

Department

UF_INTERESTS
string

Interests

UF_SKILLS
string

Skills

UF_WEB_SITES
string

Other websites

UF_XING
string

Xing

UF_LINKEDIN
string

LinkedIn

UF_FACEBOOK
string

Facebook

UF_TWITTER
string

Twitter

UF_SKYPE
string

Skype

UF_DISTRICT
string

District

UF_PHONE_INNER
string

Extension number

Code Examples

How to Use Examples in Documentation

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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        fmt.Println("done:", ok)
        

Response Handling

HTTP status: 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
                }
            }
        

Returned Data

Name
type

Description

result
boolean

Success status

time
time

Request execution time information

Error Handling

HTTP status: 400

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

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Error message

Description

ERROR_CORE

access_denied

Invalid user ID passed

ERROR_CORE

access_denied

User does not have permission to call the method

ERROR_CORE

Invalid user ID passed

Statuses and System Error Codes

HTTP Status: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

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

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning