Skip to main content

Edit calendar

Changes the calendar settings

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

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
CalendarID--calendarString, Number✔Calendar ID
FieldsStructure--fieldsStructure Of KeyAndValue✔Deal fields structure (see. GetDealStructure)
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: 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/h0m...";
    CalendarID = "362";

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

    URL        = "b24-ar17wx.bitrix24.by";
    Token      = "8536b467006e9f06006b12e400000001000...";
    CalendarID = "364";

    Result = OPI_Bitrix24.UpdateCalendar(URL, CalendarID, CalendarsStructure, Token);
    # JSON data can also be passed as a path to a .json file
    
    oint bitrix24 UpdateCalendar \
     --url "b24-ar17wx.bitrix24.by" \
     --calendar 380 \
     --fields "{'type':'user','ownerId':1,'name':'New calendar name','description':'This calendar has been changed'}" \
     --token "***"
Result
{
 "result": 80,
 "time": {
  "start": 1737396243.58751,
  "finish": 1737396243.63005,
  "duration": 0.0425360202789307,
  "processing": 0.0164361000061035,
  "date_start": "2025-01-20T21:04:03+03:00",
  "date_finish": "2025-01-20T21:04:03+03:00",
  "operating_reset_at": 1737396843,
  "operating": 0
 }
}