Skip to main content

Create user

Create new user by fields structure

Function CreateUser(Val URL, Val FieldsStructure, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
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.add

If you want to add an extranet user, you must pass in the fields: EXTRANET: Y and SONET_GROUP_ID: [...]

If you want to add an intranet user, you must pass UF_DEPARTMENT field: [...]


1C:Enterprise/OneScript code example
    URL   = "https://b24-ar17wx.bitrix24.by/rest/1/h0m...";
    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", 7);

    Result = OPI_Bitrix24.CreateUser(URL, UserStructure);

    URL   = "b24-ar17wx.bitrix24.by";
    Token = "75d8c668006e9f06006b12e400000001000...";
    Email = String(New UUID) + "@exepmple.org";

    UserStructure = New Structure;
    UserStructure.Insert("EMAIL"          , Email);
    UserStructure.Insert("NAME"           , "Vitaly");
    UserStructure.Insert("LAST_NAME"      , "Alpaca");
    UserStructure.Insert("PERSONAL_MOBILE", "88003553535");
    UserStructure.Insert("UF_DEPARTMENT"  , 1);

    Result = OPI_Bitrix24.CreateUser(URL, UserStructure, Token);
    oint bitrix24 CreateUser \
     --url ""b24-ar17wx.bitrix24.by"" \
     --fields ""/tmp/qrtlaa0g.gfu.json"" \
     --token "***"
Result
{
 "result": 2668,
 "time": {
  "start": 1757977001.54863,
  "finish": 1757977002.32455,
  "duration": 0.775922060012817,
  "processing": 0.749781847000122,
  "date_start": "2025-09-15T22:56:41+00:00",
  "date_finish": "2025-09-15T22:56:42+00:00",
  "operating_reset_at": 1757977601,
  "operating": 0.749761819839478
 }
}