Update user

Updates user data

Parameters

Function UpdateUser(Val URL, Val UserID, Val FieldsStructure, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
UserID	--userid	String, Number	✔	User ID
FieldsStructure	--fields	Structure Of KeyAndValue	✔	New user data. See. GetUserFieldsStructure
Token	--token	String	✖	Access token, when app auth method used

Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

Advanced call ?

Parameter	Description
proxy	InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication
timeout	Request execution timeout
adv_response	Formats the response as a complete HTTP structure with fields code, body, and headers
retries	Number of HTTP request send attempts on 5** status codes or internal client errors
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

tip

Method at API documentation: user.update

1C:Enterprise/OneScript code example

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
    UserID = "2958";
    Email  = String(New UUID) + "@example.org";

    // The full structure can be obtained with the function GetUserFieldsStructure

    UserStructure = New Structure;
    UserStructure.Insert("EMAIL"        , Email);
    UserStructure.Insert("UF_DEPARTMENT", 1);

    Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "a5b00469006e9f06006b12e400000001000...";
    UserID = "2960";
    Email  = String(New UUID) + "@example.org";

    UserStructure = New Structure;
    UserStructure.Insert("EMAIL"        , Email);
    UserStructure.Insert("NAME"         , "Oleg");
    UserStructure.Insert("LAST_NAME"    , "Lama");
    UserStructure.Insert("UF_DEPARTMENT", 7);

    Result = OPI_Bitrix24.UpdateUser(URL, UserID, UserStructure, Token);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateUser \
      --url "b24-ar17wx.bitrix24.by" \
      --userid 3766 \
      --fields "{'EMAIL':'328bab6a-a29c-47f3-917b-044ce520ee21@example.org','NAME':'Oleg','LAST_NAME':'Lama','UF_DEPARTMENT':'7'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateUser ^
      --url "b24-ar17wx.bitrix24.by" ^
      --userid 3766 ^
      --fields "{'EMAIL':'328bab6a-a29c-47f3-917b-044ce520ee21@example.org','NAME':'Oleg','LAST_NAME':'Lama','UF_DEPARTMENT':'7'}" ^
      --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1779804940,
  "finish": 1779804940.75094,
  "duration": 0.75094199180603,
  "processing": 0,
  "date_start": "2026-05-26T14:15:40+00:00",
  "date_finish": "2026-05-26T14:15:40+00:00",
  "operating_reset_at": 1779805540,
  "operating": 0.403472900390625
 }
}