Set user status

Sets the status (online) of the current user

Parameters

Function SetUserStatus(Val URL, Val Status, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
Status	--status	String, Number	✔	Status value: online, dnd, away
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: im.user.status.set

1C:Enterprise/OneScript code example

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

    Result = OPI_Bitrix24.SetUserStatus(URL, Status);

    URL    = "b24-ar17wx.bitrix24.by";
    Token  = "a5b00469006e9f06006b12e400000001000...";
    Status = "away";

    Result = OPI_Bitrix24.SetUserStatus(URL, Status, Token);

Bash

    oint bitrix24 SetUserStatus \
      --url "b24-ar17wx.bitrix24.by" \
      --status "away" \
      --token "***"

CMD/Bat

    oint bitrix24 SetUserStatus ^
      --url "b24-ar17wx.bitrix24.by" ^
      --status "away" ^
      --token "***"

Result

{
 "result": true,
 "time": {
  "start": 1779804793,
  "finish": 1779804793.63432,
  "duration": 0.634318113327026,
  "processing": 0,
  "date_start": "2026-05-26T14:13:13+00:00",
  "date_finish": "2026-05-26T14:13:13+00:00",
  "operating_reset_at": 1779805393,
  "operating": 0
 }
}