Skip to main content

Update user

Updates user data

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

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
UserID--useridString, Number✔User ID
FieldsStructure--fieldsStructure of KeyAndValue✔New user data. See. GetUserFieldsStructure
Token--tokenString✖Access token, when app auth method used

Returns: Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API


tip

Method at API documentation: user.update


1C:Enterprise/OneScript code example
    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/1o2...";
    UserID = "720";
    Email  = String(New UUID) + "@exepmple.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  = "35c31667006e9f06006b12e400000001000...";
    UserID = "722";
    Email  = String(New UUID) + "@exepmple.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);
    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateUser \
     --url "b24-ar17wx.bitrix24.by" \
     --userid 802 \
     --fields "{'EMAIL':'46799f0e-8d25-44d5-9ae4-3499ea858a0e@exepmple.org','NAME':'Oleg','LAST_NAME':'Lama','UF_DEPARTMENT':7}" \
     --token "***"
Result
{
 "result": true,
 "time": {
  "start": 1728454936.24134,
  "finish": 1728454936.55634,
  "duration": 0.315001964569092,
  "processing": 0.287670135498047,
  "date_start": "2024-10-09T09:22:16+03:00",
  "date_finish": "2024-10-09T09:22:16+03:00",
  "operating_reset_at": 1728455536,
  "operating": 0.287650108337402
 }
}