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:
userWho can execute the method: a user with permission to invite employees or edit all users; a user with permission to edit their own profile, for that profile only
The user.update method updates user data.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ID* |
Positive ID of the user whose data you want to update |
|
ACTIVE |
User activity flag:
The read methods user.get and user.current return this field as |
|
EMAIL |
User E-mail |
|
NAME |
First name |
|
LAST_NAME |
Last name |
|
SECOND_NAME |
Middle name |
|
PERSONAL_GENDER |
Gender: |
|
PERSONAL_PROFESSION |
Profession |
|
PERSONAL_WWW |
Homepage |
|
PERSONAL_BIRTHDAY |
Date of birth in ISO 8601 format, such as |
|
PERSONAL_PHOTO |
Photo, pass an array containing the file name and a Base64 string |
|
PERSONAL_ICQ |
ICQ |
|
PERSONAL_PHONE |
Personal phone |
|
PERSONAL_FAX |
Fax |
|
PERSONAL_MOBILE |
Personal mobile |
|
PERSONAL_PAGER |
Pager |
|
PERSONAL_STREET |
Residential street |
|
PERSONAL_CITY |
Residential city |
|
PERSONAL_STATE |
Region / territory |
|
PERSONAL_ZIP |
Postal code |
|
PERSONAL_COUNTRY |
Country |
|
PERSONAL_MAILBOX |
P.O. Box |
|
PERSONAL_NOTES |
Additional notes |
|
WORK_PHONE |
Company phone |
|
WORK_COMPANY |
Company |
|
WORK_POSITION |
Job title |
|
WORK_DEPARTMENT |
Department |
|
WORK_WWW |
Company website |
|
WORK_FAX |
Work fax |
|
WORK_PAGER |
Work pager |
|
WORK_STREET |
Street and building number of the company address |
|
WORK_MAILBOX |
Company P.O. box |
|
WORK_CITY |
Work city |
|
WORK_STATE |
State or region of the company address |
|
WORK_ZIP |
Company postal code |
|
WORK_COUNTRY |
Country of the company address |
|
WORK_PROFILE |
Company's areas of business |
|
WORK_LOGO |
Company logo. An array of file data |
|
WORK_NOTES |
Additional company notes |
|
UF_SKYPE_LINK |
Skype chat link |
|
UF_ZOOM |
Zoom |
|
UF_DEPARTMENT |
IDs of the user's departments, such as |
|
UF_INTERESTS |
Interests |
|
UF_SKILLS |
Skills |
|
UF_WEB_SITES |
Other websites |
|
UF_XING |
|
|
UF_LINKEDIN |
|
|
UF_FACEBOOK |
|
|
UF_TWITTER |
|
|
UF_SKYPE |
Skype |
|
UF_DISTRICT |
District |
|
UF_PHONE_INNER |
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();
print_r($result);
} catch (Throwable $e) {
echo $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 |
Description |
|
result |
|
|
time |
Request execution time information |
Error Handling
HTTP status: 400
{
"error": "ERROR_CORE",
"error_description": "access_denied"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
The request requires higher privileges than provided by the access token |
The |
|
|
|
access_denied |
|
|
|
|
access_denied |
Insufficient permission to change the specified user's data |
|
|
|
invalid_type_field |
An array or object is passed in a string field. The field name is returned in the The following are string fields: |
|
|
|
Error text depends on the cause |
Could not save the profile changes. The method returns a message describing the cause |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |