Обновить календарь calendar.section.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
calendarКто может выполнять метод: любой пользователь
Метод calendar.section.update обновляет календарь: изменяет только переданные параметры.
Объект access метод заменяет целиком. Календарь определяется только параметром id: тип и владелец берутся из сохраненного календаря, и права метод проверяет по ним. Параметры type и ownerId обязательны, но значения из запроса в обновление не попадают. Параметр export метод не принимает: период экспорта через этот метод не меняется, всегда all.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
type* |
Тип календаря. Возможные значения:
Параметр обязателен, но на обновление не влияет: метод берет тип из сохраненного календаря |
|
ownerId |
Идентификатор владельца календаря. Обязателен для всех типов календаря, кроме |
|
id* |
Идентификатор существующего календаря |
|
name |
Название календаря. Пустую строку метод игнорирует и оставляет прежнее название |
|
description |
Описание календаря. Пустую строку метод игнорирует: очистить описание этим методом нельзя |
|
color |
Цвет календаря в формате |
|
text_color |
Цвет текста в календаре в формате |
|
access |
Объект прав доступа к календарю (подробное описание) |
Параметр access
Формат объекта описан в разделе Параметр access метода calendar.section.add. Значение — тот же объект, что приходит в поле ACCESS ответа calendar.section.get.
Если у пользователя нет права управлять доступом к календарю, переданный объект метод молча игнорирует, а права календаря остаются прежними. Если право есть, пустой объект {} сбрасывает права к значениям по умолчанию.
Пример значения:
{
"access": {
"U1": 19,
"G2": 13
}
}
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":325,"type":"user","ownerId":2,"name":"Changed Section Name","description":"New description for section","color":"#9cbeaa","text_color":"#283099"}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/calendar.section.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":325,"type":"user","ownerId":2,"name":"Changed Section Name","description":"New description for section","color":"#9cbeaa","text_color":"#283099","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/calendar.section.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CalendarSectionUpdateResult = number
try {
const response = await $b24.actions.v2.call.make<CalendarSectionUpdateResult>({
method: 'calendar.section.update',
params: {
id: 325,
type: 'user',
ownerId: 2,
name: 'Changed Section Name',
description: 'New description for section',
color: '#9cbeaa',
text_color: '#283099',
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Updated calendar section ID:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateCalendarSection() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'calendar.section.update',
params: {
id: 325,
type: 'user',
ownerId: 2,
name: 'Changed Section Name',
description: 'New description for section',
color: '#9cbeaa',
text_color: '#283099',
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Updated calendar section ID:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCalendarSection)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.calendar.section.update(
type="user",
owner_id=2,
bitrix_id=325,
name="Changed Section Name",
description="New description for section",
color="#9cbeaa",
text_color="#283099",
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'calendar.section.update',
[
'id' => 325,
'type' => 'user',
'ownerId' => 2,
'name' => 'Changed Section Name',
'description' => 'New description for section',
'color' => '#9cbeaa',
'text_color' => '#283099',
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Дальше обработайте $result в своем коде
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating calendar section: ' . $e->getMessage();
}
BX24.callMethod(
'calendar.section.update',
{
id: 325,
type: 'user',
ownerId: 2,
name: 'Changed Section Name',
description: 'New description for section',
color: '#9cbeaa',
text_color: '#283099'
}
);
require_once('crest.php');
$result = CRest::call(
'calendar.section.update',
[
'id' => 325,
'type' => 'user',
'ownerId' => 2,
'name' => 'Changed Section Name',
'description' => 'New description for section',
'color' => '#9cbeaa',
'text_color' => '#283099'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "calendar.section.update", b24.Params{
"id": 325,
"type": "user",
"ownerId": 2,
"name": "Changed Section Name",
"description": "New description for section",
"color": "#9cbeaa",
"text_color": "#283099",
})
if err != nil {
return fmt.Errorf("calendar.section.update: %w", err)
}
var value b24.ID
if err := json.Unmarshal(res.Result, &value); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("результат:", value)
Обработка ответа
HTTP-статус: 200
{
"result": 325,
"time": {
"start": 1733828946.418185,
"finish": 1733828946.650208,
"duration": 0.23202300071716309,
"processing": 0.0054471492767333984,
"date_start": "2024-12-10T09:09:06+00:00",
"date_finish": "2024-12-10T09:09:06+00:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Идентификатор измененного календаря |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Не задан обязательный параметр \"type\" для метода \"calendar.section.update\""
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Не задан обязательный параметр "type" для метода "calendar.section.update" |
Не передан обязательный параметр |
|
|
Пустое значение |
Не задан обязательный параметр "ownerId" для метода "calendar.section.update" |
Не передан обязательный параметр |
|
|
Пустое значение |
Не задан id секции |
Не передан обязательный параметр |
|
|
Пустое значение |
Недопустимое значение параметра "name" |
Передан неверный формат данных в поле |
|
|
Пустое значение |
Недопустимое значение параметра "description" |
Передан неверный формат данных в поле |
|
|
Пустое значение |
Доступ запрещен |
Нет прав на изменение календаря. Пользователь, который не является администратором, получает эту ошибку и в том случае, если календаря с указанным |
|
|
Пустое значение |
При изменении секции произошла ошибка |
Другая ошибка |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |