Create user

Create new user by fields structure

Parameters

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

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
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.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/av5...";

    Email = "example@mail.ru";
    // 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 = "a5b00469006e9f06006b12e400000001000...";

    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);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 CreateUser \
      --url "b24-ar17wx.bitrix24.by" \
      --fields "{'EMAIL':'f3a4c187-6197-4490-9194-a7939c351fb0@mail.org','NAME':'Vitaly','LAST_NAME':'Alpaca','PERSONAL_MOBILE':'88003553535','UF_DEPARTMENT':'1'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 CreateUser ^
      --url "b24-ar17wx.bitrix24.by" ^
      --fields "{'EMAIL':'f3a4c187-6197-4490-9194-a7939c351fb0@mail.org','NAME':'Vitaly','LAST_NAME':'Alpaca','PERSONAL_MOBILE':'88003553535','UF_DEPARTMENT':'1'}" ^
      --token "***"

Result

{
 "result": 3766,
 "time": {
  "start": 1779804934,
  "finish": 1779804936.37048,
  "duration": 2.37047791481018,
  "processing": 2,
  "date_start": "2026-05-26T14:15:34+00:00",
  "date_finish": "2026-05-26T14:15:36+00:00",
  "operating_reset_at": 1779805534,
  "operating": 1.44121813774109
 }
}