Change user status

Activates or deactivates (fire) the selected user

Parameters

Function ChangeUserStatus(Val URL, Val UserID, Val Fire = True, 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
Fire	--fire	Boolean	✖	True > Deactivation, False > Activation
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)

1C:Enterprise/OneScript code example

    URL    = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
    UserID = "2958";

    Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "a5b00469006e9f06006b12e400000001000...";
    UserID = "2960";

    Result = OPI_Bitrix24.ChangeUserStatus(URL, UserID, True, Token);

Bash

    oint bitrix24 ChangeUserStatus \
      --url "b24-ar17wx.bitrix24.by" \
      --userid 3766 \
      --fire true \
      --token "***"

CMD/Bat

    oint bitrix24 ChangeUserStatus ^
      --url "b24-ar17wx.bitrix24.by" ^
      --userid 3766 ^
      --fire true ^
      --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1779804944,
  "finish": 1779804944.77986,
  "duration": 0.779861927032471,
  "processing": 0,
  "date_start": "2026-05-26T14:15:44+00:00",
  "date_finish": "2026-05-26T14:15:44+00:00",
  "operating_reset_at": 1779805544,
  "operating": 0.713789701461792
 }
}