Edit calendar

Changes the calendar settings

Parameters

Function UpdateCalendar(Val URL, Val CalendarID, Val FieldsStructure, Val Token = "") Export

Parameter	CLI option	Type	Required	Description
URL	--url	String	✔	URL of webhook or a Bitrix24 domain, when token used
CalendarID	--calendar	String, Number	✔	Calendar ID
FieldsStructure	--fields	Structure Of KeyAndValue	✔	Deal fields structure. See. GetDealStructure
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: calendar.section.update

1C:Enterprise/OneScript code example

    UserID = 1;

    CalendarsStructure = New Structure;
    CalendarsStructure.Insert("type"       , "user");
    CalendarsStructure.Insert("ownerId"    , UserID);
    CalendarsStructure.Insert("name"       , "New calendar name");
    CalendarsStructure.Insert("description", "This calendar has been changed");

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

    Result = OPI_Bitrix24.UpdateCalendar(URL, CalendarID, CalendarsStructure);

    URL        = "b24-ar17wx.bitrix24.by";
    Token      = "a5b00469006e9f06006b12e400000001000...";
    CalendarID = "1650";

    Result = OPI_Bitrix24.UpdateCalendar(URL, CalendarID, CalendarsStructure, Token);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateCalendar \
      --url "b24-ar17wx.bitrix24.by" \
      --calendar 2476 \
      --fields "{'type':'user','ownerId':'1','name':'New calendar name','description':'This calendar has been changed'}" \
      --token "***"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateCalendar ^
      --url "b24-ar17wx.bitrix24.by" ^
      --calendar 2476 ^
      --fields "{'type':'user','ownerId':'1','name':'New calendar name','description':'This calendar has been changed'}" ^
      --token "***"

Result

{
 "result": 2476,
 "time": {
  "start": 1779804980,
  "finish": 1779804980.16457,
  "duration": 0.164573907852173,
  "processing": 0,
  "date_start": "2026-05-26T14:16:20+00:00",
  "date_finish": "2026-05-26T14:16:20+00:00",
  "operating_reset_at": 1779805580,
  "operating": 0
 }
}