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 = "11ae5d68006e9f06006b12e400000001000...";
    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);
    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 CreateUser \
     --url "b24-ar17wx.bitrix24.by" \
     --fields "{'EMAIL':'b727cf59-5711-44f9-a8da-10ef1c28b9f8@exepmple.org','NAME':'Vitaly','LAST_NAME':'Alpaca','PERSONAL_MOBILE':'88003553535','UF_DEPARTMENT':1}" \
     --token "***"
Result
{
 "result": 606,
 "time": {
  "start": 1728454933.44558,
  "finish": 1728454935.61149,
  "duration": 2.16591095924377,
  "processing": 2.13802599906921,
  "date_start": "2024-10-09T09:22:13+03:00",
  "date_finish": "2024-10-09T09:22:15+03:00",
  "operating_reset_at": 1728455533,
  "operating": 2.13800406455994
 }
}